Package software.amazon.awscdk.services.appstream

Class CfnAppBlock

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appstream.CfnAppBlock
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.681Z") @Stability(Stable) public class CfnAppBlock extends CfnResource implements IInspectable
A CloudFormation AWS::AppStream::AppBlock.

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")
         .setupScriptDetails(ScriptDetailsProperty.builder()
                 .executablePath("executablePath")
                 .scriptS3Location(S3LocationProperty.builder()
                         .s3Bucket("s3Bucket")
                         .s3Key("s3Key")
                         .build())
                 .timeoutInSeconds(123)
                 // the properties below are optional
                 .executableParameters("executableParameters")
                 .build())
         .sourceS3Location(S3LocationProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 .build())
         // the properties below are optional
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnAppBlockProps props)
      Create a new AWS::AppStream::AppBlock.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • 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()
      The tags of the app block.

    • getName

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

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

    • setName

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

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

    • getSetupScriptDetails

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

    • setSetupScriptDetails

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

    • setSetupScriptDetails

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

    • getSourceS3Location

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

    • 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.