CfnApplicationProps

class aws_cdk.aws_appstream.CfnApplicationProps(*, app_block_arn, icon_s3_location, instance_families, launch_path, name, platforms, attributes_to_delete=None, description=None, display_name=None, launch_parameters=None, tags=None, working_directory=None)

Bases: object

Properties for defining a CfnApplication.

Parameters
  • app_block_arn (str) – The app block ARN with which the application should be associated.

  • icon_s3_location (Union[IResolvable, S3LocationProperty]) – The icon S3 location of the application.

  • instance_families (Sequence[str]) – The instance families the application supports. Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

  • launch_path (str) – The launch path of the application.

  • name (str) – 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}$

  • platforms (Sequence[str]) – The platforms the application supports. Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

  • attributes_to_delete (Optional[Sequence[str]]) – A list of attributes to delete from an application.

  • description (Optional[str]) – The description of the application.

  • display_name (Optional[str]) – The display name of the application. This name is visible to users in the application catalog.

  • launch_parameters (Optional[str]) – The launch parameters of the application.

  • tags (Optional[Sequence[CfnTag]]) – The tags of the application.

  • working_directory (Optional[str]) – The working directory of the application.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appstream as appstream

cfn_application_props = appstream.CfnApplicationProps(
    app_block_arn="appBlockArn",
    icon_s3_location=appstream.CfnApplication.S3LocationProperty(
        s3_bucket="s3Bucket",
        s3_key="s3Key"
    ),
    instance_families=["instanceFamilies"],
    launch_path="launchPath",
    name="name",
    platforms=["platforms"],

    # the properties below are optional
    attributes_to_delete=["attributesToDelete"],
    description="description",
    display_name="displayName",
    launch_parameters="launchParameters",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    working_directory="workingDirectory"
)

Attributes

app_block_arn

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

Link

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

Return type

str

attributes_to_delete

A list of attributes to delete from an application.

Link

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

Return type

Optional[List[str]]

description

The description of the application.

Link

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

Return type

Optional[str]

display_name

The display name of the application.

This name is visible to users in the application catalog.

Link

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

Return type

Optional[str]

icon_s3_location

The icon S3 location of the application.

Link

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

Return type

Union[IResolvable, S3LocationProperty]

instance_families

The instance families the application supports.

Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

Link

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

Return type

List[str]

launch_parameters

The launch parameters of the application.

Link

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

Return type

Optional[str]

launch_path

The launch path of the application.

Link

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

Return type

str

name

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}$

Link

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

Return type

str

platforms

The platforms the application supports.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

Link

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

Return type

List[str]

tags

The tags of the application.

Link

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

Return type

Optional[List[CfnTag]]

working_directory

The working directory of the application.

Link

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

Return type

Optional[str]