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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.617Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAppBlock.Builder A fluent builder for CfnAppBlock.
static interface	CfnAppBlock.S3LocationProperty The S3 location of the app block.
static interface	CfnAppBlock.ScriptDetailsProperty The details of the script.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAppBlock(software.constructs.Construct scope, String id, CfnAppBlockProps props) Create a new `AWS::AppStream::AppBlock`.
protected	CfnAppBlock(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAppBlock(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the app block.
String	getAttrCreatedTime() The time when the app block was created.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the app block.
String	getDisplayName() The display name of the app block.
String	getName() The name of the app block.
Object	getSetupScriptDetails() The setup script details of the app block.
Object	getSourceS3Location() The source S3 location of the app block.
TagManager	getTags() The tags of the app block.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the app block.
void	setDisplayName(String value) The display name of the app block.
void	setName(String value) The name of the app block.
void	setSetupScriptDetails(CfnAppBlock.ScriptDetailsProperty value) The setup script details of the app block.
void	setSetupScriptDetails(IResolvable value) The setup script details of the app block.
void	setSourceS3Location(CfnAppBlock.S3LocationProperty value) The source S3 location of the app block.
void	setSourceS3Location(IResolvable value) The source S3 location of the app block.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAppBlock

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

CfnAppBlock

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

CfnAppBlock

@Stability(value=Stable)
public CfnAppBlock(@NotNull
                                            software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the app block.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time when the app block was created.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags of the app block.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the app block.

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

setName

@Stability(value=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(value=Stable)
 @NotNull
public Object getSetupScriptDetails()

The setup script details of the app block.

setSetupScriptDetails

@Stability(value=Stable)
public void setSetupScriptDetails(@NotNull
                                                           CfnAppBlock.ScriptDetailsProperty value)

The setup script details of the app block.

setSetupScriptDetails

@Stability(value=Stable)
public void setSetupScriptDetails(@NotNull
                                                           IResolvable value)

The setup script details of the app block.

getSourceS3Location

@Stability(value=Stable)
 @NotNull
public Object getSourceS3Location()

The source S3 location of the app block.

setSourceS3Location

@Stability(value=Stable)
public void setSourceS3Location(@NotNull
                                                         CfnAppBlock.S3LocationProperty value)

The source S3 location of the app block.

setSourceS3Location

@Stability(value=Stable)
public void setSourceS3Location(@NotNull
                                                         IResolvable value)

The source S3 location of the app block.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the app block.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the app block.

getDisplayName

@Stability(value=Stable)
 @Nullable
public String getDisplayName()

The display name of the app block.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)

The display name of the app block.