Package software.amazon.awscdk.services.appstream

Class CfnAppBlock

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.CfnAppBlock
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IAppBlockRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:58.305Z") @Stability(Stable) public class CfnAppBlock extends CfnResource implements IInspectable, IAppBlockRef, ITaggable
This resource creates an app block.

App blocks store details about the virtual hard disk that contains the files for the application in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. App blocks are 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.*;
 CfnAppBlock cfnAppBlock = CfnAppBlock.Builder.create(this, "MyCfnAppBlock")
         .name("name")
         .sourceS3Location(S3LocationProperty.builder()
                 .s3Bucket("s3Bucket")
                 // the properties below are optional
                 .s3Key("s3Key")
                 .build())
         // the properties below are optional
         .description("description")
         .displayName("displayName")
         .packagingType("packagingType")
         .postSetupScriptDetails(ScriptDetailsProperty.builder()
                 .executablePath("executablePath")
                 .scriptS3Location(S3LocationProperty.builder()
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .s3Key("s3Key")
                         .build())
                 .timeoutInSeconds(123)
                 // the properties below are optional
                 .executableParameters("executableParameters")
                 .build())
         .setupScriptDetails(ScriptDetailsProperty.builder()
                 .executablePath("executablePath")
                 .scriptS3Location(S3LocationProperty.builder()
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .s3Key("s3Key")
                         .build())
                 .timeoutInSeconds(123)
                 // the properties below are optional
                 .executableParameters("executableParameters")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAppBlock

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

    • CfnAppBlock

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

    • CfnAppBlock

      @Stability(Stable) public CfnAppBlock(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppBlockProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAppBlockRef

      @Stability(Stable) @NotNull public AppBlockReference getAppBlockRef()
      A reference to a AppBlock resource.
      Specified by:
      getAppBlockRef in interface IAppBlockRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the app block.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time when the app block was created.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the app block.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the app block.

    • getSourceS3Location

      @Stability(Stable) @NotNull public Object getSourceS3Location()
      The source S3 location of the app block.

      Returns union: either IResolvable or CfnAppBlock.S3LocationProperty

    • setSourceS3Location

      @Stability(Stable) public void setSourceS3Location(@NotNull IResolvable value)
      The source S3 location of the app block.

    • setSourceS3Location

      @Stability(Stable) public void setSourceS3Location(@NotNull CfnAppBlock.S3LocationProperty value)
      The source S3 location of the app block.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the app block.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the app block.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the app block.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the app block.

    • getPackagingType

      @Stability(Stable) @Nullable public String getPackagingType()
      The packaging type of the app block.

    • setPackagingType

      @Stability(Stable) public void setPackagingType(@Nullable String value)
      The packaging type of the app block.

    • getPostSetupScriptDetails

      @Stability(Stable) @Nullable public Object getPostSetupScriptDetails()
      The post setup script details of the app block.

      Returns union: either IResolvable or CfnAppBlock.ScriptDetailsProperty

    • setPostSetupScriptDetails

      @Stability(Stable) public void setPostSetupScriptDetails(@Nullable IResolvable value)
      The post setup script details of the app block.

    • setPostSetupScriptDetails

      @Stability(Stable) public void setPostSetupScriptDetails(@Nullable CfnAppBlock.ScriptDetailsProperty value)
      The post setup script details of the app block.

    • getSetupScriptDetails

      @Stability(Stable) @Nullable public Object getSetupScriptDetails()
      The setup script details of the app block.

      Returns union: either IResolvable or CfnAppBlock.ScriptDetailsProperty

    • setSetupScriptDetails

      @Stability(Stable) public void setSetupScriptDetails(@Nullable IResolvable value)
      The setup script details of the app block.

    • setSetupScriptDetails

      @Stability(Stable) public void setSetupScriptDetails(@Nullable CfnAppBlock.ScriptDetailsProperty value)
      The setup script details of the app block.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags of the app block.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags of the app block.