Skip to content

Resource: awsAppstreamStack

Provides an AppStream stack.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.appstreamStack.AppstreamStack(this, "example", {
  applicationSettings: {
    enabled: true,
    settingsGroup: "SettingsGroup",
  },
  description: "stack description",
  displayName: "stack display name",
  feedbackUrl: "http://your-domain/feedback",
  name: "stack name",
  redirectUrl: "http://your-domain/redirect",
  storageConnectors: [
    {
      connectorType: "HOMEFOLDERS",
    },
  ],
  tags: {
    TagName: "TagValue",
  },
  userSettings: [
    {
      action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE",
      permission: "ENABLED",
    },
    {
      action: "CLIPBOARD_COPY_TO_LOCAL_DEVICE",
      permission: "ENABLED",
    },
    {
      action: "DOMAIN_PASSWORD_SIGNIN",
      permission: "ENABLED",
    },
    {
      action: "DOMAIN_SMART_CARD_SIGNIN",
      permission: "DISABLED",
    },
    {
      action: "FILE_DOWNLOAD",
      permission: "ENABLED",
    },
    {
      action: "FILE_UPLOAD",
      permission: "ENABLED",
    },
    {
      action: "PRINTING_TO_LOCAL_DEVICE",
      permission: "ENABLED",
    },
  ],
});

Argument Reference

The following arguments are required:

  • name - (Required) Unique name for the AppStream stack.

The following arguments are optional:

  • accessEndpoints - (Optional) Set of configuration blocks defining the interface VPC endpoints. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. See accessEndpoints below.
  • applicationSettings - (Optional) Settings for application settings persistence. See applicationSettings below.
  • description - (Optional) Description for the AppStream stack.
  • displayName - (Optional) Stack name to display.
  • embedHostDomains - (Optional) Domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
  • feedbackUrl - (Optional) URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed. .
  • redirectUrl - (Optional) URL that users are redirected to after their streaming session ends.
  • storageConnectors - (Optional) Configuration block for the storage connectors to enable. See storageConnectors below.
  • userSettings - (Optional) Configuration block for the actions that are enabled or disabled for users during their streaming sessions. If not provided, these settings are configured automatically by AWS. If provided, the terraform configuration should include a block for each configurable action. See userSettings below.
  • tags - (Optional) Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

accessEndpoints

  • endpointType - (Required) Type of the interface endpoint. See the accessEndpoint AWS API documentation for valid values.
  • vpceId - (Optional) ID of the VPC in which the interface endpoint is used.

applicationSettings

  • enabled - (Required) Whether application settings should be persisted.
  • settingsGroup - (Optional) Name of the settings group. Required when enabled is true. Can be up to 100 characters.

storageConnectors

  • connectorType - (Required) Type of storage connector. Valid values are homefolders, GOOGLE_DRIVE, or ONE_DRIVE.
  • domains - (Optional) Names of the domains for the account.
  • resourceIdentifier - (Optional) ARN of the storage connector.

userSettings

  • action - (Required) Action that is enabled or disabled. Valid values are CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE, DOMAIN_PASSWORD_SIGNIN, or DOMAIN_SMART_CARD_SIGNIN.
  • permission - (Required) Whether the action is enabled or disabled. Valid values are enabled or disabled.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - ARN of the appstream stack.
  • createdTime - Date and time, in UTC and extended RFC 3339 format, when the stack was created.
  • id - Unique ID of the appstream stack.

Import

awsAppstreamStack can be imported using the id, e.g.,

$ terraform import aws_appstream_stack.example stackID