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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.646Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStack.AccessEndpointProperty Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0.
static interface	CfnStack.ApplicationSettingsProperty The persistent application settings for users of a stack.
static class	CfnStack.Builder A fluent builder for CfnStack.
static interface	CfnStack.StorageConnectorProperty A connector that enables persistent storage for users.
static interface	CfnStack.StreamingExperienceSettingsProperty Example:
static interface	CfnStack.UserSettingProperty Specifies an action and whether the action is enabled or disabled for users during their streaming sessions.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStack(software.constructs.Construct scope, String id) Create a new `AWS::AppStream::Stack`.
	CfnStack(software.constructs.Construct scope, String id, CfnStackProps props) Create a new `AWS::AppStream::Stack`.
protected	CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccessEndpoints() The list of virtual private cloud (VPC) interface endpoint objects.
Object	getApplicationSettings() The persistent application settings for users of the stack.
List<String>	getAttributesToDelete() The stack attributes to delete.
protected Map<String,Object>	getCfnProperties()
Object	getDeleteStorageConnectors() *This parameter has been deprecated.*.
String	getDescription() The description to display.
String	getDisplayName() The stack name to display.
List<String>	getEmbedHostDomains() The domains where AppStream 2.0 streaming sessions can be embedded in an iframe.
String	getFeedbackUrl() The URL that users are redirected to after they click the Send Feedback link.
String	getName() The name of the stack.
String	getRedirectUrl() The URL that users are redirected to after their streaming session ends.
Object	getStorageConnectors() The storage connectors to enable.
Object	getStreamingExperienceSettings() `AWS::AppStream::Stack.StreamingExperienceSettings`.
TagManager	getTags() An array of key-value pairs.
Object	getUserSettings() The actions that are enabled or disabled for users during their streaming sessions.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessEndpoints(IResolvable value) The list of virtual private cloud (VPC) interface endpoint objects.
void	setAccessEndpoints(List<Object> value) The list of virtual private cloud (VPC) interface endpoint objects.
void	setApplicationSettings(CfnStack.ApplicationSettingsProperty value) The persistent application settings for users of the stack.
void	setApplicationSettings(IResolvable value) The persistent application settings for users of the stack.
void	setAttributesToDelete(List<String> value) The stack attributes to delete.
void	setDeleteStorageConnectors(Boolean value) *This parameter has been deprecated.*.
void	setDeleteStorageConnectors(IResolvable value) *This parameter has been deprecated.*.
void	setDescription(String value) The description to display.
void	setDisplayName(String value) The stack name to display.
void	setEmbedHostDomains(List<String> value) The domains where AppStream 2.0 streaming sessions can be embedded in an iframe.
void	setFeedbackUrl(String value) The URL that users are redirected to after they click the Send Feedback link.
void	setName(String value) The name of the stack.
void	setRedirectUrl(String value) The URL that users are redirected to after their streaming session ends.
void	setStorageConnectors(IResolvable value) The storage connectors to enable.
void	setStorageConnectors(List<Object> value) The storage connectors to enable.
void	setStreamingExperienceSettings(CfnStack.StreamingExperienceSettingsProperty value) `AWS::AppStream::Stack.StreamingExperienceSettings`.
void	setStreamingExperienceSettings(IResolvable value) `AWS::AppStream::Stack.StreamingExperienceSettings`.
void	setUserSettings(IResolvable value) The actions that are enabled or disabled for users during their streaming sessions.
void	setUserSettings(List<Object> value) The actions that are enabled or disabled for users during their streaming sessions.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStack

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

CfnStack

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

CfnStack

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnStack

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs.

getAccessEndpoints

@Stability(value=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(value=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(value=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(value=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(value=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.

setApplicationSettings

@Stability(value=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.

getAttributesToDelete

@Stability(value=Stable)
 @Nullable
public List<String> getAttributesToDelete()

The stack attributes to delete.

setAttributesToDelete

@Stability(value=Stable)
public void setAttributesToDelete(@Nullable
                                                           List<String> value)

The stack attributes to delete.

getDeleteStorageConnectors

@Stability(value=Stable)
 @Nullable
public Object getDeleteStorageConnectors()

*This parameter has been deprecated.*.

Deletes the storage connectors currently enabled for the stack.

setDeleteStorageConnectors

@Stability(value=Stable)
public void setDeleteStorageConnectors(@Nullable
                                                                Boolean value)

*This parameter has been deprecated.*.

Deletes the storage connectors currently enabled for the stack.

setDeleteStorageConnectors

@Stability(value=Stable)
public void setDeleteStorageConnectors(@Nullable
                                                                IResolvable value)

*This parameter has been deprecated.*.

Deletes the storage connectors currently enabled for the stack.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description to display.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description to display.

getDisplayName

@Stability(value=Stable)
 @Nullable
public String getDisplayName()

The stack name to display.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)

The stack name to display.

getEmbedHostDomains

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getName()

The name of the stack.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the stack.

getRedirectUrl

@Stability(value=Stable)
 @Nullable
public String getRedirectUrl()

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

setRedirectUrl

@Stability(value=Stable)
public void setRedirectUrl(@Nullable
                                                    String value)

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

getStorageConnectors

@Stability(value=Stable)
 @Nullable
public Object getStorageConnectors()

The storage connectors to enable.

setStorageConnectors

@Stability(value=Stable)
public void setStorageConnectors(@Nullable
                                                          IResolvable value)

The storage connectors to enable.

setStorageConnectors

@Stability(value=Stable)
public void setStorageConnectors(@Nullable
                                                          List<Object> value)

The storage connectors to enable.

getStreamingExperienceSettings

@Stability(value=Stable)
 @Nullable
public Object getStreamingExperienceSettings()

`AWS::AppStream::Stack.StreamingExperienceSettings`.

setStreamingExperienceSettings

@Stability(value=Stable)
public void setStreamingExperienceSettings(@Nullable
                                                                    CfnStack.StreamingExperienceSettingsProperty value)

`AWS::AppStream::Stack.StreamingExperienceSettings`.

setStreamingExperienceSettings

@Stability(value=Stable)
public void setStreamingExperienceSettings(@Nullable
                                                                    IResolvable value)

`AWS::AppStream::Stack.StreamingExperienceSettings`.

getUserSettings

@Stability(value=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(value=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(value=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.