software.amazon.awscdk.services.appstream

Class CfnApplication

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

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.619Z")
 @Stability(value=Stable)
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::Application`.

This resource creates an application. Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .appBlockArn("appBlockArn")
         .iconS3Location(S3LocationProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .build())
         .instanceFamilies(List.of("instanceFamilies"))
         .launchPath("launchPath")
         .name("name")
         .platforms(List.of("platforms"))
         // the properties below are optional
         .attributesToDelete(List.of("attributesToDelete"))
         .description("description")
         .displayName("displayName")
         .launchParameters("launchParameters")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplication.Builder A fluent builder for CfnApplication.
static interface	CfnApplication.S3LocationProperty The S3 location of the application icon.

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
	CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) Create a new `AWS::AppStream::Application`.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppBlockArn() The app block ARN with which the application should be associated.
String	getAttrArn() The ARN of the application.
String	getAttrCreatedTime() The time when the application was created.
List<String>	getAttributesToDelete() A list of attributes to delete from an application.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the application.
String	getDisplayName() The display name of the application.
Object	getIconS3Location() The icon S3 location of the application.
List<String>	getInstanceFamilies() The instance families the application supports.
String	getLaunchParameters() The launch parameters of the application.
String	getLaunchPath() The launch path of the application.
String	getName() The name of the application.
List<String>	getPlatforms() The platforms the application supports.
TagManager	getTags() The tags of the application.
String	getWorkingDirectory() The working directory of the application.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppBlockArn(String value) The app block ARN with which the application should be associated.
void	setAttributesToDelete(List<String> value) A list of attributes to delete from an application.
void	setDescription(String value) The description of the application.
void	setDisplayName(String value) The display name of the application.
void	setIconS3Location(CfnApplication.S3LocationProperty value) The icon S3 location of the application.
void	setIconS3Location(IResolvable value) The icon S3 location of the application.
void	setInstanceFamilies(List<String> value) The instance families the application supports.
void	setLaunchParameters(String value) The launch parameters of the application.
void	setLaunchPath(String value) The launch path of the application.
void	setName(String value) The name of the application.
void	setPlatforms(List<String> value) The platforms the application supports.
void	setWorkingDirectory(String value) The working directory of the application.

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

CfnApplication

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

CfnApplication

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

CfnApplication

@Stability(value=Stable)
public CfnApplication(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnApplicationProps props)

Create a new `AWS::AppStream::Application`.

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

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the application.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time when the application was created.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags of the application.

getAppBlockArn

@Stability(value=Stable)
 @NotNull
public String getAppBlockArn()

The app block ARN with which the application should be associated.

setAppBlockArn

@Stability(value=Stable)
public void setAppBlockArn(@NotNull
                                                    String value)

The app block ARN with which the application should be associated.

getIconS3Location

@Stability(value=Stable)
 @NotNull
public Object getIconS3Location()

The icon S3 location of the application.

setIconS3Location

@Stability(value=Stable)
public void setIconS3Location(@NotNull
                                                       CfnApplication.S3LocationProperty value)

The icon S3 location of the application.

setIconS3Location

@Stability(value=Stable)
public void setIconS3Location(@NotNull
                                                       IResolvable value)

The icon S3 location of the application.

getInstanceFamilies

@Stability(value=Stable)
 @NotNull
public List<String> getInstanceFamilies()

The instance families the application supports.

Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

setInstanceFamilies

@Stability(value=Stable)
public void setInstanceFamilies(@NotNull
                                                         List<String> value)

The instance families the application supports.

Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

getLaunchPath

@Stability(value=Stable)
 @NotNull
public String getLaunchPath()

The launch path of the application.

setLaunchPath

@Stability(value=Stable)
public void setLaunchPath(@NotNull
                                                   String value)

The launch path of the application.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the application.

This name is visible to users when a name is not specified in the DisplayName property.

Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

setName

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

The name of the application.

This name is visible to users when a name is not specified in the DisplayName property.

Pattern : ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

getPlatforms

@Stability(value=Stable)
 @NotNull
public List<String> getPlatforms()

The platforms the application supports.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

setPlatforms

@Stability(value=Stable)
public void setPlatforms(@NotNull
                                                  List<String> value)

The platforms the application supports.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

getAttributesToDelete

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

A list of attributes to delete from an application.

setAttributesToDelete

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

A list of attributes to delete from an application.

getDescription

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

The description of the application.

setDescription

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

The description of the application.

getDisplayName

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

The display name of the application.

This name is visible to users in the application catalog.

setDisplayName

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

The display name of the application.

This name is visible to users in the application catalog.

getLaunchParameters

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

The launch parameters of the application.

setLaunchParameters

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

The launch parameters of the application.

getWorkingDirectory

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

The working directory of the application.

setWorkingDirectory

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

The working directory of the application.