software.amazon.awscdk.services.appstream

Class CfnImageBuilder

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

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.641Z")
 @Stability(value=Stable)
public class CfnImageBuilder
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::ImageBuilder`.

The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.

The initial state of the image builder is PENDING . When it is ready, the state is RUNNING .

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.*;
 CfnImageBuilder cfnImageBuilder = CfnImageBuilder.Builder.create(this, "MyCfnImageBuilder")
         .instanceType("instanceType")
         .name("name")
         // the properties below are optional
         .accessEndpoints(List.of(AccessEndpointProperty.builder()
                 .endpointType("endpointType")
                 .vpceId("vpceId")
                 .build()))
         .appstreamAgentVersion("appstreamAgentVersion")
         .description("description")
         .displayName("displayName")
         .domainJoinInfo(DomainJoinInfoProperty.builder()
                 .directoryName("directoryName")
                 .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                 .build())
         .enableDefaultInternetAccess(false)
         .iamRoleArn("iamRoleArn")
         .imageArn("imageArn")
         .imageName("imageName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnImageBuilder.AccessEndpointProperty Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0.
static class	CfnImageBuilder.Builder A fluent builder for CfnImageBuilder.
static interface	CfnImageBuilder.DomainJoinInfoProperty The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
static interface	CfnImageBuilder.VpcConfigProperty The VPC configuration for the image builder.

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
	CfnImageBuilder(software.constructs.Construct scope, String id, CfnImageBuilderProps props) Create a new `AWS::AppStream::ImageBuilder`.
protected	CfnImageBuilder(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnImageBuilder(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccessEndpoints() The list of virtual private cloud (VPC) interface endpoint objects.
String	getAppstreamAgentVersion() The version of the AppStream 2.0 agent to use for this image builder.
String	getAttrStreamingUrl() The URL to start an image builder streaming session, returned as a string.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description to display.
String	getDisplayName() The image builder name to display.
Object	getDomainJoinInfo() The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
Object	getEnableDefaultInternetAccess() Enables or disables default internet access for the image builder.
String	getIamRoleArn() The ARN of the IAM role that is applied to the image builder.
String	getImageArn() The ARN of the public, private, or shared image to use.
String	getImageName() The name of the image used to create the image builder.
String	getInstanceType() The instance type to use when launching the image builder.
String	getName() A unique name for the image builder.
TagManager	getTags() An array of key-value pairs.
Object	getVpcConfig() The VPC configuration for the image builder.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessEndpoints(IResolvable value) The list of virtual private cloud (VPC) interface endpoint objects.
void	setAccessEndpoints(List<Object> value) The list of virtual private cloud (VPC) interface endpoint objects.
void	setAppstreamAgentVersion(String value) The version of the AppStream 2.0 agent to use for this image builder.
void	setDescription(String value) The description to display.
void	setDisplayName(String value) The image builder name to display.
void	setDomainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty value) The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
void	setDomainJoinInfo(IResolvable value) The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
void	setEnableDefaultInternetAccess(Boolean value) Enables or disables default internet access for the image builder.
void	setEnableDefaultInternetAccess(IResolvable value) Enables or disables default internet access for the image builder.
void	setIamRoleArn(String value) The ARN of the IAM role that is applied to the image builder.
void	setImageArn(String value) The ARN of the public, private, or shared image to use.
void	setImageName(String value) The name of the image used to create the image builder.
void	setInstanceType(String value) The instance type to use when launching the image builder.
void	setName(String value) A unique name for the image builder.
void	setVpcConfig(CfnImageBuilder.VpcConfigProperty value) The VPC configuration for the image builder.
void	setVpcConfig(IResolvable value) The VPC configuration for the image builder.

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

CfnImageBuilder

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

CfnImageBuilder

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

CfnImageBuilder

@Stability(value=Stable)
public CfnImageBuilder(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnImageBuilderProps props)

Create a new `AWS::AppStream::ImageBuilder`.

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.

getAttrStreamingUrl

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

The URL to start an image builder streaming session, returned as a string.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

An array of key-value pairs.

getInstanceType

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

The instance type to use when launching the image builder. The following instance types are available:.

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

setInstanceType

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

The instance type to use when launching the image builder. The following instance types are available:.

• stream.standard.small
• stream.standard.medium
• stream.standard.large
• stream.compute.large
• stream.compute.xlarge
• stream.compute.2xlarge
• stream.compute.4xlarge
• stream.compute.8xlarge
• stream.memory.large
• stream.memory.xlarge
• stream.memory.2xlarge
• stream.memory.4xlarge
• stream.memory.8xlarge
• stream.memory.z1d.large
• stream.memory.z1d.xlarge
• stream.memory.z1d.2xlarge
• stream.memory.z1d.3xlarge
• stream.memory.z1d.6xlarge
• stream.memory.z1d.12xlarge
• stream.graphics-design.large
• stream.graphics-design.xlarge
• stream.graphics-design.2xlarge
• stream.graphics-design.4xlarge
• stream.graphics-desktop.2xlarge
• stream.graphics.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics-pro.4xlarge
• stream.graphics-pro.8xlarge
• stream.graphics-pro.16xlarge

getName

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

A unique name for the image builder.

setName

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

A unique name for the image builder.

getAccessEndpoints

@Stability(value=Stable)
 @Nullable
public Object getAccessEndpoints()

The list of virtual private cloud (VPC) interface endpoint objects.

Administrators can connect to the image builder only through the specified endpoints.

setAccessEndpoints

@Stability(value=Stable)
public void setAccessEndpoints(@Nullable
                                                        IResolvable value)

The list of virtual private cloud (VPC) interface endpoint objects.

Administrators can connect to the image builder only through the specified endpoints.

setAccessEndpoints

@Stability(value=Stable)
public void setAccessEndpoints(@Nullable
                                                        List<Object> value)

The list of virtual private cloud (VPC) interface endpoint objects.

Administrators can connect to the image builder only through the specified endpoints.

getAppstreamAgentVersion

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

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

setAppstreamAgentVersion

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

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

getDescription

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

The description to display.

setDescription

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

The description to display.

getDisplayName

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

The image builder name to display.

setDisplayName

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

The image builder name to display.

getDomainJoinInfo

@Stability(value=Stable)
 @Nullable
public Object getDomainJoinInfo()

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

setDomainJoinInfo

@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       CfnImageBuilder.DomainJoinInfoProperty value)

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

setDomainJoinInfo

@Stability(value=Stable)
public void setDomainJoinInfo(@Nullable
                                                       IResolvable value)

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

getEnableDefaultInternetAccess

@Stability(value=Stable)
 @Nullable
public Object getEnableDefaultInternetAccess()

Enables or disables default internet access for the image builder.

setEnableDefaultInternetAccess

@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    Boolean value)

Enables or disables default internet access for the image builder.

setEnableDefaultInternetAccess

@Stability(value=Stable)
public void setEnableDefaultInternetAccess(@Nullable
                                                                    IResolvable value)

Enables or disables default internet access for the image builder.

getIamRoleArn

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

The ARN of the IAM role that is applied to the image builder.

To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

setIamRoleArn

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

The ARN of the IAM role that is applied to the image builder.

To assume a role, the image builder calls the AWS Security Token Service AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .

getImageArn

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

The ARN of the public, private, or shared image to use.

setImageArn

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

The ARN of the public, private, or shared image to use.

getImageName

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

The name of the image used to create the image builder.

setImageName

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

The name of the image used to create the image builder.

getVpcConfig

@Stability(value=Stable)
 @Nullable
public Object getVpcConfig()

The VPC configuration for the image builder.

You can specify only one subnet.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnImageBuilder.VpcConfigProperty value)

The VPC configuration for the image builder.

You can specify only one subnet.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  IResolvable value)

The VPC configuration for the image builder.

You can specify only one subnet.