@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.458Z") public class CfnImageBuilder extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnImageBuilder(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnImageBuilder(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnImageBuilder(Construct scope, java.lang.String id, CfnImageBuilderProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrStreamingUrl()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getInstanceType()
public void setInstanceType(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getAccessEndpoints()
Administrators can connect to the image builder only through the specified endpoints.
public void setAccessEndpoints(IResolvable value)
Administrators can connect to the image builder only through the specified endpoints.
public void setAccessEndpoints(java.util.List<java.lang.Object> value)
Administrators can connect to the image builder only through the specified endpoints.
public java.lang.String getAppstreamAgentVersion()
public void setAppstreamAgentVersion(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String value)
public java.lang.Object getDomainJoinInfo()
public void setDomainJoinInfo(IResolvable value)
public void setDomainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty value)
public java.lang.Object getEnableDefaultInternetAccess()
public void setEnableDefaultInternetAccess(java.lang.Boolean value)
public void setEnableDefaultInternetAccess(IResolvable value)
public java.lang.String getIamRoleArn()
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 .
public void setIamRoleArn(java.lang.String value)
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 .
public java.lang.String getImageArn()
public void setImageArn(java.lang.String value)
public java.lang.String getImageName()
public void setImageName(java.lang.String value)
public java.lang.Object getVpcConfig()
You can specify only one subnet.
public void setVpcConfig(IResolvable value)
You can specify only one subnet.
public void setVpcConfig(CfnImageBuilder.VpcConfigProperty value)
You can specify only one subnet.