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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.022Z")
 @Stability(value=Stable)
public class CfnAppBlock
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::AppBlock`.

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 Example:
static interface	CfnAppBlock.ScriptDetailsProperty Example:

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()
String	getAttrCreatedTime()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::AppStream::AppBlock.Description`.
String	getDisplayName() `AWS::AppStream::AppBlock.DisplayName`.
String	getName() `AWS::AppStream::AppBlock.Name`.
Object	getSetupScriptDetails() `AWS::AppStream::AppBlock.SetupScriptDetails`.
Object	getSourceS3Location() `AWS::AppStream::AppBlock.SourceS3Location`.
TagManager	getTags() `AWS::AppStream::AppBlock.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::AppStream::AppBlock.Description`.
void	setDisplayName(String value) `AWS::AppStream::AppBlock.DisplayName`.
void	setName(String value) `AWS::AppStream::AppBlock.Name`.
void	setSetupScriptDetails(CfnAppBlock.ScriptDetailsProperty value) `AWS::AppStream::AppBlock.SetupScriptDetails`.
void	setSetupScriptDetails(IResolvable value) `AWS::AppStream::AppBlock.SetupScriptDetails`.
void	setSourceS3Location(CfnAppBlock.S3LocationProperty value) `AWS::AppStream::AppBlock.SourceS3Location`.
void	setSourceS3Location(IResolvable value) `AWS::AppStream::AppBlock.SourceS3Location`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getAttrCreatedTime

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDescription

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

`AWS::AppStream::AppBlock.Description`.

setDescription

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

`AWS::AppStream::AppBlock.Description`.

getDisplayName

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

`AWS::AppStream::AppBlock.DisplayName`.

setDisplayName

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

`AWS::AppStream::AppBlock.DisplayName`.

getName

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

`AWS::AppStream::AppBlock.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::AppStream::AppBlock.Name`.

getSetupScriptDetails

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

`AWS::AppStream::AppBlock.SetupScriptDetails`.

setSetupScriptDetails

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

`AWS::AppStream::AppBlock.SetupScriptDetails`.

setSetupScriptDetails

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

`AWS::AppStream::AppBlock.SetupScriptDetails`.

getSourceS3Location

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

`AWS::AppStream::AppBlock.SourceS3Location`.

setSourceS3Location

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

`AWS::AppStream::AppBlock.SourceS3Location`.

setSourceS3Location

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

`AWS::AppStream::AppBlock.SourceS3Location`.

getTags

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

`AWS::AppStream::AppBlock.Tags`.