CfnImageBuilderProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.appstream.CfnImageBuilderProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnImageBuilderProps>

Enclosing interface:: CfnImageBuilderProps

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

A builder for CfnImageBuilderProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnImageBuilderProps.Builder`	`accessEndpoints(IResolvable accessEndpoints)` Sets the value of `CfnImageBuilderProps.getAccessEndpoints()`
`CfnImageBuilderProps.Builder`	`accessEndpoints(List<? extends Object> accessEndpoints)` Sets the value of `CfnImageBuilderProps.getAccessEndpoints()`
`CfnImageBuilderProps.Builder`	`appstreamAgentVersion(String appstreamAgentVersion)` Sets the value of `CfnImageBuilderProps.getAppstreamAgentVersion()`
`CfnImageBuilderProps`	`build()` Builds the configured instance.
`CfnImageBuilderProps.Builder`	`description(String description)` Sets the value of `CfnImageBuilderProps.getDescription()`
`CfnImageBuilderProps.Builder`	`displayName(String displayName)` Sets the value of `CfnImageBuilderProps.getDisplayName()`
`CfnImageBuilderProps.Builder`	`domainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty domainJoinInfo)` Sets the value of `CfnImageBuilderProps.getDomainJoinInfo()`
`CfnImageBuilderProps.Builder`	`domainJoinInfo(IResolvable domainJoinInfo)` Sets the value of `CfnImageBuilderProps.getDomainJoinInfo()`
`CfnImageBuilderProps.Builder`	`enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)` Sets the value of `CfnImageBuilderProps.getEnableDefaultInternetAccess()`
`CfnImageBuilderProps.Builder`	`enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)` Sets the value of `CfnImageBuilderProps.getEnableDefaultInternetAccess()`
`CfnImageBuilderProps.Builder`	`iamRoleArn(String iamRoleArn)` Sets the value of `CfnImageBuilderProps.getIamRoleArn()`
`CfnImageBuilderProps.Builder`	`imageArn(String imageArn)` Sets the value of `CfnImageBuilderProps.getImageArn()`
`CfnImageBuilderProps.Builder`	`imageName(String imageName)` Sets the value of `CfnImageBuilderProps.getImageName()`
`CfnImageBuilderProps.Builder`	`instanceType(String instanceType)` Sets the value of `CfnImageBuilderProps.getInstanceType()`
`CfnImageBuilderProps.Builder`	`name(String name)` Sets the value of `CfnImageBuilderProps.getName()`
`CfnImageBuilderProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnImageBuilderProps.getTags()`
`CfnImageBuilderProps.Builder`	`vpcConfig(CfnImageBuilder.VpcConfigProperty vpcConfig)` Sets the value of `CfnImageBuilderProps.getVpcConfig()`
`CfnImageBuilderProps.Builder`	`vpcConfig(IResolvable vpcConfig)` Sets the value of `CfnImageBuilderProps.getVpcConfig()`

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - instanceType
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder instanceType(String instanceType)
```
    Sets the value of CfnImageBuilderProps.getInstanceType()
    Parameters:
    instanceType - The instance type to use when launching the image builder. The following instance types are available:. This parameter is required.
    
    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
    Returns:
    
    this
  - name
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder name(String name)
```
    Sets the value of CfnImageBuilderProps.getName()
    
    Parameters:
    
    name - A unique name for the image builder. This parameter is required.
    
    Returns:
    
    this
  - accessEndpoints
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder accessEndpoints(IResolvable accessEndpoints)
```
    Sets the value of CfnImageBuilderProps.getAccessEndpoints()
    
    Parameters:
    
    accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
    
    Returns:
    
    this
  - accessEndpoints
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder accessEndpoints(List<? extends Object> accessEndpoints)
```
    Sets the value of CfnImageBuilderProps.getAccessEndpoints()
    
    Parameters:
    
    accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
    
    Returns:
    
    this
  - appstreamAgentVersion
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder appstreamAgentVersion(String appstreamAgentVersion)
```
    Sets the value of CfnImageBuilderProps.getAppstreamAgentVersion()
    
    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].
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder description(String description)
```
    Sets the value of CfnImageBuilderProps.getDescription()
    
    Parameters:
    
    description - The description to display.
    
    Returns:
    
    this
  - displayName
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder displayName(String displayName)
```
    Sets the value of CfnImageBuilderProps.getDisplayName()
    
    Parameters:
    
    displayName - The image builder name to display.
    
    Returns:
    
    this
  - domainJoinInfo
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder domainJoinInfo(CfnImageBuilder.DomainJoinInfoProperty domainJoinInfo)
```
    Sets the value of CfnImageBuilderProps.getDomainJoinInfo()
    
    Parameters:
    
    domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
    
    Returns:
    
    this
  - domainJoinInfo
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder domainJoinInfo(IResolvable domainJoinInfo)
```
    Sets the value of CfnImageBuilderProps.getDomainJoinInfo()
    
    Parameters:
    
    domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
    
    Returns:
    
    this
  - enableDefaultInternetAccess
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
```
    Sets the value of CfnImageBuilderProps.getEnableDefaultInternetAccess()
    
    Parameters:
    
    enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
    
    Returns:
    
    this
  - enableDefaultInternetAccess
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder enableDefaultInternetAccess(IResolvable enableDefaultInternetAccess)
```
    Sets the value of CfnImageBuilderProps.getEnableDefaultInternetAccess()
    
    Parameters:
    
    enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
    
    Returns:
    
    this
  - iamRoleArn
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder iamRoleArn(String iamRoleArn)
```
    Sets the value of CfnImageBuilderProps.getIamRoleArn()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - imageArn
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder imageArn(String imageArn)
```
    Sets the value of CfnImageBuilderProps.getImageArn()
    
    Parameters:
    
    imageArn - The ARN of the public, private, or shared image to use.
    
    Returns:
    
    this
  - imageName
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder imageName(String imageName)
```
    Sets the value of CfnImageBuilderProps.getImageName()
    
    Parameters:
    
    imageName - The name of the image used to create the image builder.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnImageBuilderProps.getTags()
    
    Parameters:
    
    tags - An array of key-value pairs.
    
    Returns:
    
    this
  - vpcConfig
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder vpcConfig(CfnImageBuilder.VpcConfigProperty vpcConfig)
```
    Sets the value of CfnImageBuilderProps.getVpcConfig()
    
    Parameters:
    
    vpcConfig - The VPC configuration for the image builder. You can specify only one subnet.
    
    Returns:
    
    this
  - vpcConfig
```
@Stability(value=Stable)
public CfnImageBuilderProps.Builder vpcConfig(IResolvable vpcConfig)
```
    Sets the value of CfnImageBuilderProps.getVpcConfig()
    
    Parameters:
    
    vpcConfig - The VPC configuration for the image builder. You can specify only one subnet.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnImageBuilderProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnImageBuilderProps>
    
    Returns:
    
    a new instance of CfnImageBuilderProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnImageBuilderProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

instanceType

name

accessEndpoints

accessEndpoints

appstreamAgentVersion

description

displayName

domainJoinInfo

domainJoinInfo

enableDefaultInternetAccess

enableDefaultInternetAccess

iamRoleArn

imageArn

imageName

tags

vpcConfig

vpcConfig

build