aws-cdk-lib.aws_appstream.CfnStackProps

interface CfnStackProps

LanguageType name
.NETAmazon.CDK.AWS.AppStream.CfnStackProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappstream#CfnStackProps
Javasoftware.amazon.awscdk.services.appstream.CfnStackProps
Pythonaws_cdk.aws_appstream.CfnStackProps
TypeScript aws-cdk-lib » aws_appstream » CfnStackProps

Properties for defining a CfnStack.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const cfnStackProps: appstream.CfnStackProps = {
  accessEndpoints: [{
    endpointType: 'endpointType',
    vpceId: 'vpceId',
  }],
  applicationSettings: {
    enabled: false,

    // the properties below are optional
    settingsGroup: 'settingsGroup',
  },
  attributesToDelete: ['attributesToDelete'],
  deleteStorageConnectors: false,
  description: 'description',
  displayName: 'displayName',
  embedHostDomains: ['embedHostDomains'],
  feedbackUrl: 'feedbackUrl',
  name: 'name',
  redirectUrl: 'redirectUrl',
  storageConnectors: [{
    connectorType: 'connectorType',

    // the properties below are optional
    domains: ['domains'],
    resourceIdentifier: 'resourceIdentifier',
  }],
  streamingExperienceSettings: {
    preferredProtocol: 'preferredProtocol',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userSettings: [{
    action: 'action',
    permission: 'permission',
  }],
};

Properties

NameTypeDescription
accessEndpoints?IResolvable | IResolvable | AccessEndpointProperty[]The list of virtual private cloud (VPC) interface endpoint objects.
applicationSettings?IResolvable | ApplicationSettingsPropertyThe persistent application settings for users of the stack.
attributesToDelete?string[]The stack attributes to delete.
deleteStorageConnectors?boolean | IResolvableThis parameter has been deprecated..
description?stringThe description to display.
displayName?stringThe stack name to display.
embedHostDomains?string[]The 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?stringThe URL that users are redirected to after they click the Send Feedback link.
name?stringThe name of the stack.
redirectUrl?stringThe URL that users are redirected to after their streaming session ends.
storageConnectors?IResolvable | IResolvable | StorageConnectorProperty[]The storage connectors to enable.
streamingExperienceSettings?IResolvable | StreamingExperienceSettingsPropertyThe streaming protocol that you want your stack to prefer.
tags?CfnTag[]An array of key-value pairs.
userSettings?IResolvable | IResolvable | UserSettingProperty[]The actions that are enabled or disabled for users during their streaming sessions.

accessEndpoints?

Type: IResolvable | IResolvable | AccessEndpointProperty[] (optional)

The list of virtual private cloud (VPC) interface endpoint objects.

Users of the stack can connect to AppStream 2.0 only through the specified endpoints.


applicationSettings?

Type: IResolvable | ApplicationSettingsProperty (optional)

The persistent application settings for users of the stack.

When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.


attributesToDelete?

Type: string[] (optional)

The stack attributes to delete.


deleteStorageConnectors?

Type: boolean | IResolvable (optional)

This parameter has been deprecated..

Deletes the storage connectors currently enabled for the stack.


description?

Type: string (optional)

The description to display.


displayName?

Type: string (optional)

The stack name to display.


embedHostDomains?

Type: string[] (optional)

The 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?

Type: string (optional)

The URL that users are redirected to after they click the Send Feedback link.

If no URL is specified, no Send Feedback link is displayed.


name?

Type: string (optional)

The name of the stack.


redirectUrl?

Type: string (optional)

The URL that users are redirected to after their streaming session ends.


storageConnectors?

Type: IResolvable | IResolvable | StorageConnectorProperty[] (optional)

The storage connectors to enable.


streamingExperienceSettings?

Type: IResolvable | StreamingExperienceSettingsProperty (optional)

The streaming protocol that you want your stack to prefer.

This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.


tags?

Type: CfnTag[] (optional)

An array of key-value pairs.


userSettings?

Type: IResolvable | IResolvable | UserSettingProperty[] (optional)

The actions that are enabled or disabled for users during their streaming sessions.

By default, these actions are enabled.