Package software.amazon.awscdk.services.appstream

Class CfnStack

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appstream.CfnStack
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.735Z") @Stability(Stable) public class CfnStack extends CfnResource implements IInspectable
A CloudFormation AWS::AppStream::Stack.

The AWS::AppStream::Stack resource creates a stack to start streaming applications to Amazon AppStream 2.0 users. A stack consists of an associated fleet, user access policies, and storage configurations.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appstream.*;
 CfnStack cfnStack = CfnStack.Builder.create(this, "MyCfnStack")
         .accessEndpoints(List.of(AccessEndpointProperty.builder()
                 .endpointType("endpointType")
                 .vpceId("vpceId")
                 .build()))
         .applicationSettings(ApplicationSettingsProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .settingsGroup("settingsGroup")
                 .build())
         .attributesToDelete(List.of("attributesToDelete"))
         .deleteStorageConnectors(false)
         .description("description")
         .displayName("displayName")
         .embedHostDomains(List.of("embedHostDomains"))
         .feedbackUrl("feedbackUrl")
         .name("name")
         .redirectUrl("redirectUrl")
         .storageConnectors(List.of(StorageConnectorProperty.builder()
                 .connectorType("connectorType")
                 // the properties below are optional
                 .domains(List.of("domains"))
                 .resourceIdentifier("resourceIdentifier")
                 .build()))
         .streamingExperienceSettings(StreamingExperienceSettingsProperty.builder()
                 .preferredProtocol("preferredProtocol")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userSettings(List.of(UserSettingProperty.builder()
                 .action("action")
                 .permission("permission")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStack

      protected CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStack

      protected CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStack

      @Stability(Stable) public CfnStack(@NotNull Construct scope, @NotNull String id, @Nullable CfnStackProps props)
      Create a new AWS::AppStream::Stack.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnStack

      @Stability(Stable) public CfnStack(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::AppStream::Stack.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs.

    • getAccessEndpoints

      @Stability(Stable) @Nullable public Object getAccessEndpoints()
      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.

    • setAccessEndpoints

      @Stability(Stable) public void setAccessEndpoints(@Nullable IResolvable value)
      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.

    • setAccessEndpoints

      @Stability(Stable) public void setAccessEndpoints(@Nullable List<Object> value)
      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.

    • getApplicationSettings

      @Stability(Stable) @Nullable public Object getApplicationSettings()
      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.

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable IResolvable value)
      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.

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable CfnStack.ApplicationSettingsProperty value)
      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.

    • getAttributesToDelete

      @Stability(Stable) @Nullable public List<String> getAttributesToDelete()
      The stack attributes to delete.

    • setAttributesToDelete

      @Stability(Stable) public void setAttributesToDelete(@Nullable List<String> value)
      The stack attributes to delete.

    • getDeleteStorageConnectors

      @Stability(Stable) @Nullable public Object getDeleteStorageConnectors()
      This parameter has been deprecated..

      Deletes the storage connectors currently enabled for the stack.

    • setDeleteStorageConnectors

      @Stability(Stable) public void setDeleteStorageConnectors(@Nullable Boolean value)
      This parameter has been deprecated..

      Deletes the storage connectors currently enabled for the stack.

    • setDeleteStorageConnectors

      @Stability(Stable) public void setDeleteStorageConnectors(@Nullable IResolvable value)
      This parameter has been deprecated..

      Deletes the storage connectors currently enabled for the stack.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description to display.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description to display.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The stack name to display.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The stack name to display.

    • getEmbedHostDomains

      @Stability(Stable) @Nullable public List<String> getEmbedHostDomains()
      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.

    • setEmbedHostDomains

      @Stability(Stable) public void setEmbedHostDomains(@Nullable List<String> value)
      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.

    • getFeedbackUrl

      @Stability(Stable) @Nullable public String getFeedbackUrl()
      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.

    • setFeedbackUrl

      @Stability(Stable) public void setFeedbackUrl(@Nullable String value)
      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.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the stack.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the stack.

    • getRedirectUrl

      @Stability(Stable) @Nullable public String getRedirectUrl()
      The URL that users are redirected to after their streaming session ends.

    • setRedirectUrl

      @Stability(Stable) public void setRedirectUrl(@Nullable String value)
      The URL that users are redirected to after their streaming session ends.

    • getStorageConnectors

      @Stability(Stable) @Nullable public Object getStorageConnectors()
      The storage connectors to enable.

    • setStorageConnectors

      @Stability(Stable) public void setStorageConnectors(@Nullable IResolvable value)
      The storage connectors to enable.

    • setStorageConnectors

      @Stability(Stable) public void setStorageConnectors(@Nullable List<Object> value)
      The storage connectors to enable.

    • getStreamingExperienceSettings

      @Stability(Stable) @Nullable public Object getStreamingExperienceSettings()
      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.

    • setStreamingExperienceSettings

      @Stability(Stable) public void setStreamingExperienceSettings(@Nullable IResolvable value)
      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.

    • setStreamingExperienceSettings

      @Stability(Stable) public void setStreamingExperienceSettings(@Nullable CfnStack.StreamingExperienceSettingsProperty value)
      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.

    • getUserSettings

      @Stability(Stable) @Nullable public Object getUserSettings()
      The actions that are enabled or disabled for users during their streaming sessions.

      By default, these actions are enabled.

    • setUserSettings

      @Stability(Stable) public void setUserSettings(@Nullable IResolvable value)
      The actions that are enabled or disabled for users during their streaming sessions.

      By default, these actions are enabled.

    • setUserSettings

      @Stability(Stable) public void setUserSettings(@Nullable List<Object> value)
      The actions that are enabled or disabled for users during their streaming sessions.

      By default, these actions are enabled.