software.amazon.awscdk.services.appstream

Class CfnImageBuilder.Builder

java.lang.Object

software.amazon.awscdk.services.appstream.CfnImageBuilder.Builder

Enclosing class:

CfnImageBuilder

public static final class CfnImageBuilder.Builder
extends java.lang.Object

A fluent builder for CfnImageBuilder.

Method Summary

Modifier and Type	Method and Description
CfnImageBuilder.Builder	accessEndpoints(IResolvable accessEndpoints) The list of virtual private cloud (VPC) interface endpoint objects.
CfnImageBuilder.Builder	accessEndpoints(java.util.List<? extends java.lang.Object> accessEndpoints) The list of virtual private cloud (VPC) interface endpoint objects.
CfnImageBuilder.Builder	appstreamAgentVersion(java.lang.String appstreamAgentVersion) The version of the AppStream 2.0 agent to use for this image builder.
CfnImageBuilder	build()
static CfnImageBuilder.Builder	create(Construct scope, java.lang.String id)
CfnImageBuilder.Builder	description(java.lang.String description) The description to display.
CfnImageBuilder.Builder	displayName(java.lang.String displayName) The image builder name to display.
CfnImageBuilder.Builder	domainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty domainJoinInfo) The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
CfnImageBuilder.Builder	domainJoinInfo(IResolvable domainJoinInfo) The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
CfnImageBuilder.Builder	enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess) Enables or disables default internet access for the image builder.
CfnImageBuilder.Builder	enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess) Enables or disables default internet access for the image builder.
CfnImageBuilder.Builder	iamRoleArn(java.lang.String iamRoleArn) The ARN of the IAM role that is applied to the image builder.
CfnImageBuilder.Builder	imageArn(java.lang.String imageArn) The ARN of the public, private, or shared image to use.
CfnImageBuilder.Builder	imageName(java.lang.String imageName) The name of the image used to create the image builder.
CfnImageBuilder.Builder	instanceType(java.lang.String instanceType) The instance type to use when launching the image builder.
CfnImageBuilder.Builder	name(java.lang.String name) A unique name for the image builder.
CfnImageBuilder.Builder	tags(java.util.List<? extends CfnTag> tags) An array of key-value pairs.
CfnImageBuilder.Builder	vpcConfig(CfnImageBuilder.VpcConfigProperty vpcConfig) The VPC configuration for the image builder.
CfnImageBuilder.Builder	vpcConfig(IResolvable vpcConfig) The VPC configuration for the image builder.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnImageBuilder.Builder create(Construct scope,
                                             java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnImageBuilder.AccessEndpointProperty.Builder.

instanceType

public CfnImageBuilder.Builder instanceType(java.lang.String instanceType)

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

Parameters:

instanceType - The instance type to use when launching the image builder. The following instance types are available:. This parameter is required.

Returns:

this

name

public CfnImageBuilder.Builder name(java.lang.String name)

A unique name for the image builder.

Parameters:

name - A unique name for the image builder. This parameter is required.

Returns:

this

accessEndpoints

public CfnImageBuilder.Builder accessEndpoints(IResolvable accessEndpoints)

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

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

Parameters:

accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. This parameter is required.

Returns:

this

accessEndpoints

public CfnImageBuilder.Builder accessEndpoints(java.util.List<? extends java.lang.Object> accessEndpoints)

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

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

Parameters:

accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. This parameter is required.

Returns:

this

appstreamAgentVersion

public CfnImageBuilder.Builder appstreamAgentVersion(java.lang.String appstreamAgentVersion)

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

Parameters:

appstreamAgentVersion - 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]. This parameter is required.

Returns:

this

description

public CfnImageBuilder.Builder description(java.lang.String description)

The description to display.

Parameters:

description - The description to display. This parameter is required.

Returns:

this

displayName

public CfnImageBuilder.Builder displayName(java.lang.String displayName)

The image builder name to display.

Parameters:

displayName - The image builder name to display. This parameter is required.

Returns:

this

domainJoinInfo

public CfnImageBuilder.Builder domainJoinInfo(IResolvable domainJoinInfo)

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

Parameters:

domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. This parameter is required.

Returns:

this

domainJoinInfo

public CfnImageBuilder.Builder domainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty domainJoinInfo)

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

Parameters:

domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. This parameter is required.

Returns:

this

enableDefaultInternetAccess

public CfnImageBuilder.Builder enableDefaultInternetAccess(java.lang.Boolean enableDefaultInternetAccess)

Enables or disables default internet access for the image builder.

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the image builder. This parameter is required.

Returns:

this

enableDefaultInternetAccess

public CfnImageBuilder.Builder enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)

Enables or disables default internet access for the image builder.

Parameters:

enableDefaultInternetAccess - Enables or disables default internet access for the image builder. This parameter is required.

Returns:

this

iamRoleArn

public CfnImageBuilder.Builder iamRoleArn(java.lang.String iamRoleArn)

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 .

Parameters:

iamRoleArn - The ARN of the IAM role that is applied to the image builder. This parameter is required.

Returns:

this

imageArn

public CfnImageBuilder.Builder imageArn(java.lang.String imageArn)

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

Parameters:

imageArn - The ARN of the public, private, or shared image to use. This parameter is required.

Returns:

this

imageName

public CfnImageBuilder.Builder imageName(java.lang.String imageName)

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

Parameters:

imageName - The name of the image used to create the image builder. This parameter is required.

Returns:

this

tags

public CfnImageBuilder.Builder tags(java.util.List<? extends CfnTag> tags)

An array of key-value pairs.

Parameters:

tags - An array of key-value pairs. This parameter is required.

Returns:

this

vpcConfig

public CfnImageBuilder.Builder vpcConfig(IResolvable vpcConfig)

The VPC configuration for the image builder.

You can specify only one subnet.

Parameters:

vpcConfig - The VPC configuration for the image builder. This parameter is required.

Returns:

this

vpcConfig

public CfnImageBuilder.Builder vpcConfig(CfnImageBuilder.VpcConfigProperty vpcConfig)

The VPC configuration for the image builder.

You can specify only one subnet.

Parameters:

vpcConfig - The VPC configuration for the image builder. This parameter is required.

Returns:

this

build

public CfnImageBuilder build()