Package software.amazon.awscdk.services.appstream

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:12.662Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

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.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
String	getAppBlockArn()	The app block ARN with which the application should be associated.
default List<String>	getAttributesToDelete()	A list of attributes to delete from an application.
default String	getDescription()	The description of the application.
default 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.
default 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.
default List<CfnTag>	getTags()	The tags of the application.
default String	getWorkingDirectory()	The working directory of the application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppBlockArn

@Stability(Stable)
@NotNull
String getAppBlockArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-appblockarn

getIconS3Location

@Stability(Stable)
@NotNull
Object getIconS3Location()

The icon S3 location of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-icons3location

getInstanceFamilies

@Stability(Stable)
@NotNull
List<String> getInstanceFamilies()

The instance families the application supports.

Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-instancefamilies

getLaunchPath

@Stability(Stable)
@NotNull
String getLaunchPath()

The launch path of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchpath

getName

@Stability(Stable)
@NotNull
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}$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-name

getPlatforms

@Stability(Stable)
@NotNull
List<String> getPlatforms()

The platforms the application supports.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-platforms

getAttributesToDelete

@Stability(Stable)
@Nullable
default List<String> getAttributesToDelete()

A list of attributes to delete from an application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-attributestodelete

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-description

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The display name of the application.

This name is visible to users in the application catalog.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-displayname

getLaunchParameters

@Stability(Stable)
@Nullable
default String getLaunchParameters()

The launch parameters of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchparameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-tags

getWorkingDirectory

@Stability(Stable)
@Nullable
default String getWorkingDirectory()

The working directory of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-workingdirectory

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps