Package software.amazon.awscdk.services.appstream

Class CfnStack

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appstream.CfnStack
All Implemented Interfaces:
IInspectable, IStackRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:05.024Z") @Stability(Stable) public class CfnStack extends CfnResource implements IInspectable, IStackRef, ITaggable
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")
                 // the properties below are optional
                 .maximumLength(123)
                 .build()))
         .build();

See Also:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnStack

      @Stability(Stable) public CfnStack(@NotNull software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • isCfnStack

      @Stability(Stable) @NotNull public static Boolean isCfnStack(@NotNull Object x)
      Checks whether the given object is a CfnStack.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getStackRef

      @Stability(Stable) @NotNull public StackReference getStackRef()
      A reference to a Stack resource.
      Specified by:
      getStackRef in interface IStackRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAccessEndpoints

      @Stability(Stable) @Nullable public Object getAccessEndpoints()
      The list of virtual private cloud (VPC) interface endpoint objects.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStack.AccessEndpointProperty>

    • setAccessEndpoints

      @Stability(Stable) public void setAccessEndpoints(@Nullable IResolvable value)
      The list of virtual private cloud (VPC) interface endpoint objects.

    • setAccessEndpoints

      @Stability(Stable) public void setAccessEndpoints(@Nullable List<Object> value)
      The list of virtual private cloud (VPC) interface endpoint objects.

    • getApplicationSettings

      @Stability(Stable) @Nullable public Object getApplicationSettings()
      The persistent application settings for users of the stack.

      Returns union: either IResolvable or CfnStack.ApplicationSettingsProperty

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable IResolvable value)
      The persistent application settings for users of the stack.

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable CfnStack.ApplicationSettingsProperty value)
      The persistent application settings for users of the stack.

    • 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..

      Returns union: either Boolean or IResolvable

    • setDeleteStorageConnectors

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

    • setDeleteStorageConnectors

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

    • 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 WorkSpaces Applications streaming sessions can be embedded in an iframe.

    • setEmbedHostDomains

      @Stability(Stable) public void setEmbedHostDomains(@Nullable List<String> value)
      The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe.

    • getFeedbackUrl

      @Stability(Stable) @Nullable public String getFeedbackUrl()
      The URL that users are redirected to after they click the Send Feedback link.

    • setFeedbackUrl

      @Stability(Stable) public void setFeedbackUrl(@Nullable String value)
      The URL that users are redirected to after they click the Send Feedback link.

    • 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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStack.StorageConnectorProperty>

    • 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.

      Returns union: either IResolvable or CfnStack.StreamingExperienceSettingsProperty

    • setStreamingExperienceSettings

      @Stability(Stable) public void setStreamingExperienceSettings(@Nullable IResolvable value)
      The streaming protocol that you want your stack to prefer.

    • setStreamingExperienceSettings

      @Stability(Stable) public void setStreamingExperienceSettings(@Nullable CfnStack.StreamingExperienceSettingsProperty value)
      The streaming protocol that you want your stack to prefer.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs.

    • getUserSettings

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStack.UserSettingProperty>

    • setUserSettings

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

    • setUserSettings

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