Package software.amazon.awscdk.services.appstream

Interface CfnAppBlockProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppBlockProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:28.746Z")
@Stability(Stable)
public interface CfnAppBlockProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAppBlock.

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.*;
 CfnAppBlockProps cfnAppBlockProps = CfnAppBlockProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAppBlockProps.Builder	A builder for CfnAppBlockProps
static final class	CfnAppBlockProps.Jsii$Proxy	An implementation for CfnAppBlockProps

Method Summary

Modifier and Type	Method	Description
static CfnAppBlockProps.Builder	builder()
default String	getDescription()	The description of the app block.
default String	getDisplayName()	The display name of the app block.
String	getName()	The name of the app block.
default String	getPackagingType()	The packaging type of the app block.
default Object	getPostSetupScriptDetails()	The post setup script details of the app block.
default Object	getSetupScriptDetails()	The setup script details of the app block.
Object	getSourceS3Location()	The source S3 location of the app block.
default List<CfnTag>	getTags()	The tags of the app block.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the app block.

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

See Also:

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

getSourceS3Location

@Stability(Stable)
@NotNull
Object getSourceS3Location()

The source S3 location of the app block.

Returns union: either IResolvable or CfnAppBlock.S3LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-sources3location

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the app block.

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The display name of the app block.

See Also:

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

getPackagingType

@Stability(Stable)
@Nullable
default String getPackagingType()

The packaging type of the app block.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-packagingtype

getPostSetupScriptDetails

@Stability(Stable)
@Nullable
default Object getPostSetupScriptDetails()

The post setup script details of the app block.

Returns union: either IResolvable or CfnAppBlock.ScriptDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-postsetupscriptdetails

getSetupScriptDetails

@Stability(Stable)
@Nullable
default Object getSetupScriptDetails()

The setup script details of the app block.

Returns union: either IResolvable or CfnAppBlock.ScriptDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-setupscriptdetails

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags of the app block.

See Also:

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

builder

@Stability(Stable)
static CfnAppBlockProps.Builder builder()

Returns:

a CfnAppBlockProps.Builder of CfnAppBlockProps