Skip to content
v2.277.0

CfnApplicationProps Struct ​

Properties for defining a CfnApplication.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const cfnApplicationProps: appstream.CfnApplicationProps = {
  appBlockArn: 'appBlockArn',
  iconS3Location: {
    s3Bucket: 's3Bucket',
    s3Key: 's3Key',
  },
  instanceFamilies: ['instanceFamilies'],
  launchPath: 'launchPath',
  name: 'name',
  platforms: ['platforms'],

  // the properties below are optional
  attributesToDelete: ['attributesToDelete'],
  description: 'description',
  displayName: 'displayName',
  launchParameters: 'launchParameters',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workingDirectory: 'workingDirectory',
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppStream;

var cfnApplicationProps = new CfnApplicationProps {
    AppBlockArn = "appBlockArn",
    IconS3Location = new S3LocationProperty {
        S3Bucket = "s3Bucket",
        S3Key = "s3Key"
    },
    InstanceFamilies = new [] { "instanceFamilies" },
    LaunchPath = "launchPath",
    Name = "name",
    Platforms = new [] { "platforms" },

    // the properties below are optional
    AttributesToDelete = new [] { "attributesToDelete" },
    Description = "description",
    DisplayName = "displayName",
    LaunchParameters = "launchParameters",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    WorkingDirectory = "workingDirectory"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnApplicationProps := &CfnApplicationProps{
	AppBlockArn: jsii.String("appBlockArn"),
	IconS3Location: &S3LocationProperty{
		S3Bucket: jsii.String("s3Bucket"),
		S3Key: jsii.String("s3Key"),
	},
	InstanceFamilies: []*string{
		jsii.String("instanceFamilies"),
	},
	LaunchPath: jsii.String("launchPath"),
	Name: jsii.String("name"),
	Platforms: []*string{
		jsii.String("platforms"),
	},

	// the properties below are optional
	AttributesToDelete: []*string{
		jsii.String("attributesToDelete"),
	},
	Description: jsii.String("description"),
	DisplayName: jsii.String("displayName"),
	LaunchParameters: jsii.String("launchParameters"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	WorkingDirectory: jsii.String("workingDirectory"),
}

Properties ​

appBlockArnstringapp_block_arnstrappBlockArnStringAppBlockArnstringAppBlockArn*stringrequired#
The app block ARN with which the application should be associated.
attributesToDeleteoptionalstring[]attributes_to_deleteoptionaltyping.List[str]attributesToDeleteoptionalList<String>AttributesToDeleteoptionalstring[]AttributesToDeleteoptional*[]*string#
A list of attributes to delete from an application.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the application.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
The display name of the application.

This name is visible to users in the application catalog.

iconS3LocationIResolvable | CfnApplication.S3LocationPropertyicon_s3_locationtyping.Union[IResolvable, S3LocationProperty]iconS3LocationIResolvableIconS3LocationIResolvableIconS3Locationinterface{}required#
The icon S3 location of the application.
instanceFamiliesstring[]instance_familiestyping.List[str]instanceFamiliesList<String>InstanceFamiliesstring[]InstanceFamilies*[]*stringrequired#
The instance families the application supports.

Allowed Values : GENERAL_PURPOSE | GRAPHICS_G4

launchParametersoptionalstringlaunch_parametersoptionalstrlaunchParametersoptionalStringLaunchParametersoptionalstringLaunchParametersoptional*string#
The launch parameters of the application.
launchPathstringlaunch_pathstrlaunchPathStringLaunchPathstringLaunchPath*stringrequired#
The launch path of the application.
namestringnamestrnameStringNamestringName*stringrequired#
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}$

platformsstring[]platformstyping.List[str]platformsList<String>Platformsstring[]Platforms*[]*stringrequired#
The platforms the application supports.

Allowed Values : WINDOWS_SERVER_2019 | AMAZON_LINUX2

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags of the application.
workingDirectoryoptionalstringworking_directoryoptionalstrworkingDirectoryoptionalStringWorkingDirectoryoptionalstringWorkingDirectoryoptional*string#
The working directory of the application.