CfnImageBuilder

java.lang.Object
- 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.CfnImageBuilder

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.458Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnImageBuilder(Construct scope, java.lang.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

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

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnImageBuilder(Construct scope,
                       java.lang.String id,
                       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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrStreamingUrl
```
public java.lang.String getAttrStreamingUrl()
```
    The URL to start an image builder streaming session, returned as a string.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs.
  - getInstanceType
```
public java.lang.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
```
public void setInstanceType(java.lang.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
```
public java.lang.String getName()
```
    A unique name for the image builder.
  - setName
```
public void setName(java.lang.String value)
```
    A unique name for the image builder.
  - getAccessEndpoints
```
public java.lang.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
```
public void setAccessEndpoints(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
```
public void setAccessEndpoints(java.util.List<java.lang.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
```
public java.lang.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
```
public void setAppstreamAgentVersion(java.lang.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
```
public java.lang.String getDescription()
```
    The description to display.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description to display.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    The image builder name to display.
  - setDisplayName
```
public void setDisplayName(java.lang.String value)
```
    The image builder name to display.
  - getDomainJoinInfo
```
public java.lang.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
```
public 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.
  - setDomainJoinInfo
```
public 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.
  - getEnableDefaultInternetAccess
```
public java.lang.Object getEnableDefaultInternetAccess()
```
    Enables or disables default internet access for the image builder.
  - setEnableDefaultInternetAccess
```
public void setEnableDefaultInternetAccess(java.lang.Boolean value)
```
    Enables or disables default internet access for the image builder.
  - setEnableDefaultInternetAccess
```
public void setEnableDefaultInternetAccess(IResolvable value)
```
    Enables or disables default internet access for the image builder.
  - getIamRoleArn
```
public java.lang.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
```
public void setIamRoleArn(java.lang.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
```
public java.lang.String getImageArn()
```
    The ARN of the public, private, or shared image to use.
  - setImageArn
```
public void setImageArn(java.lang.String value)
```
    The ARN of the public, private, or shared image to use.
  - getImageName
```
public java.lang.String getImageName()
```
    The name of the image used to create the image builder.
  - setImageName
```
public void setImageName(java.lang.String value)
```
    The name of the image used to create the image builder.
  - getVpcConfig
```
public java.lang.Object getVpcConfig()
```
    The VPC configuration for the image builder.
    You can specify only one subnet.
  - setVpcConfig
```
public void setVpcConfig(IResolvable value)
```
    The VPC configuration for the image builder.
    You can specify only one subnet.
  - setVpcConfig
```
public void setVpcConfig(CfnImageBuilder.VpcConfigProperty value)
```
    The VPC configuration for the image builder.
    You can specify only one subnet.

Class CfnImageBuilder

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnImageBuilder

CfnImageBuilder

CfnImageBuilder

Method Detail

inspect

renderProperties

getAttrStreamingUrl

getCfnProperties

getTags

getInstanceType

setInstanceType

getName

setName

getAccessEndpoints

setAccessEndpoints

setAccessEndpoints

getAppstreamAgentVersion

setAppstreamAgentVersion

getDescription

setDescription

getDisplayName

setDisplayName

getDomainJoinInfo

setDomainJoinInfo

setDomainJoinInfo

getEnableDefaultInternetAccess

setEnableDefaultInternetAccess

setEnableDefaultInternetAccess

getIamRoleArn

setIamRoleArn

getImageArn

setImageArn

getImageName

setImageName

getVpcConfig

setVpcConfig

setVpcConfig