Skip to content
v2.275.0

CfnAppBlockProps Struct ​

Properties for defining a CfnAppBlock.

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 cfnAppBlockProps: appstream.CfnAppBlockProps = {
  name: 'name',
  sourceS3Location: {
    s3Bucket: 's3Bucket',

    // the properties below are optional
    s3Key: 's3Key',
  },

  // the properties below are optional
  description: 'description',
  displayName: 'displayName',
  packagingType: 'packagingType',
  postSetupScriptDetails: {
    executablePath: 'executablePath',
    scriptS3Location: {
      s3Bucket: 's3Bucket',

      // the properties below are optional
      s3Key: 's3Key',
    },
    timeoutInSeconds: 123,

    // the properties below are optional
    executableParameters: 'executableParameters',
  },
  setupScriptDetails: {
    executablePath: 'executablePath',
    scriptS3Location: {
      s3Bucket: 's3Bucket',

      // the properties below are optional
      s3Key: 's3Key',
    },
    timeoutInSeconds: 123,

    // the properties below are optional
    executableParameters: 'executableParameters',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the app block.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
The display name of the app block.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the app block.

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

packagingTypeoptionalstringpackaging_typeoptionalstrpackagingTypeoptionalStringPackagingTypeoptionalstringPackagingTypeoptional*string#
The packaging type of the app block.
postSetupScriptDetailsoptionalIResolvable | CfnAppBlock.ScriptDetailsPropertypost_setup_script_detailsoptionaltyping.Union[IResolvable, ScriptDetailsProperty]postSetupScriptDetailsoptionalIResolvablePostSetupScriptDetailsoptionalIResolvablePostSetupScriptDetailsoptionalinterface{}#
The post setup script details of the app block.
setupScriptDetailsoptionalIResolvable | CfnAppBlock.ScriptDetailsPropertysetup_script_detailsoptionaltyping.Union[IResolvable, ScriptDetailsProperty]setupScriptDetailsoptionalIResolvableSetupScriptDetailsoptionalIResolvableSetupScriptDetailsoptionalinterface{}#
The setup script details of the app block.
sourceS3LocationIResolvable | CfnAppBlock.S3LocationPropertysource_s3_locationtyping.Union[IResolvable, S3LocationProperty]sourceS3LocationIResolvableSourceS3LocationIResolvableSourceS3Locationinterface{}required#
The source S3 location of the app block.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags of the app block.