Package software.amazon.awscdk.cfnpropertymixins.services.appstream

Class CfnImageBuilderPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.appstream.CfnImageBuilderPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImageBuilderPropsMixin>

Enclosing class:

CfnImageBuilderPropsMixin

@Stability(Stable)
public static final class CfnImageBuilderPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnImageBuilderPropsMixin>

A fluent builder for CfnImageBuilderPropsMixin.

Method Summary

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

create

@Stability(Stable)
public static CfnImageBuilderPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnImageBuilderPropsMixin.Builder.

create

@Stability(Stable)
public static CfnImageBuilderPropsMixin.Builder create()

Returns:

a new instance of CfnImageBuilderPropsMixin.Builder.

accessEndpoints

@Stability(Stable)
public CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints

accessEndpoints

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder accessEndpoints(List<? extends 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints

appstreamAgentVersion

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder appstreamAgentVersion(String appstreamAgentVersion)

The version of the WorkSpaces Applications agent to use for this image builder.

To use the latest version of the WorkSpaces Applications agent, specify [LATEST].

Parameters:

appstreamAgentVersion - The version of the WorkSpaces Applications agent to use for this image builder. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-appstreamagentversion

description

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder description(String description)

The description to display.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-description

displayName

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder displayName(String displayName)

The image builder name to display.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-displayname

domainJoinInfo

@Stability(Stable)
public CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-domainjoininfo

domainJoinInfo

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder domainJoinInfo(CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-domainjoininfo

enableDefaultInternetAccess

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder enableDefaultInternetAccess(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-enabledefaultinternetaccess

enableDefaultInternetAccess

@Stability(Stable)
public CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-enabledefaultinternetaccess

iamRoleArn

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder iamRoleArn(String iamRoleArn)

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

To assume a role, the image builder calls the 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-iamrolearn

imageArn

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder imageArn(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagearn

imageName

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder imageName(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagename

instanceType

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder instanceType(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.g4dn.xlarge
• stream.graphics.g4dn.2xlarge
• stream.graphics.g4dn.4xlarge
• stream.graphics.g4dn.8xlarge
• stream.graphics.g4dn.12xlarge
• stream.graphics.g4dn.16xlarge
• stream.graphics.g5.xlarge
• stream.graphics.g5.2xlarge
• stream.graphics.g5.4xlarge
• stream.graphics.g5.8xlarge
• stream.graphics.g5.16xlarge
• stream.graphics.g5.12xlarge
• stream.graphics.g5.24xlarge
• stream.graphics.g6.xlarge
• stream.graphics.g6.2xlarge
• stream.graphics.g6.4xlarge
• stream.graphics.g6.8xlarge
• stream.graphics.g6.16xlarge
• stream.graphics.g6.12xlarge
• stream.graphics.g6.24xlarge
• stream.graphics.gr6.4xlarge
• stream.graphics.gr6.8xlarge
• stream.graphics.g6f.large
• stream.graphics.g6f.xlarge
• stream.graphics.g6f.2xlarge
• stream.graphics.g6f.4xlarge
• stream.graphics.gr6f.4xlarge

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-instancetype

name

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder name(String name)

A unique name for the image builder.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-name

tags

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-tags

vpcConfig

@Stability(Stable)
public CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-vpcconfig

vpcConfig

@Stability(Stable)
public CfnImageBuilderPropsMixin.Builder vpcConfig(CfnImageBuilderPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-vpcconfig

build

@Stability(Stable)
public CfnImageBuilderPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnImageBuilderPropsMixin>

Returns:

a newly built instance of CfnImageBuilderPropsMixin.