software.amazon.awssdk.services.appstream.model

Class CreateImageBuilderRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.CreateImageBuilderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateImageBuilderRequest
extends AppStreamRequest
implements ToCopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateImageBuilderRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AccessEndpoint>	accessEndpoints() The list of interface VPC endpoint (interface endpoint) objects.
String	appstreamAgentVersion() The version of the AppStream 2.0 agent to use for this image builder.
static CreateImageBuilderRequest.Builder	builder()
String	description() The description to display.
String	displayName() The image builder name to display.
DomainJoinInfo	domainJoinInfo() The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
Boolean	enableDefaultInternetAccess() Enables or disables default internet access for the image builder.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasAccessEndpoints() Returns true if the AccessEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamRoleArn() The Amazon Resource Name (ARN) of the IAM role to apply to the image builder.
String	imageArn() The ARN of the public, private, or shared image to use.
String	imageName() The name of the image used to create the image builder.
String	instanceType() The instance type to use when launching the image builder.
String	name() A unique name for the image builder.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateImageBuilderRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags to associate with the image builder.
CreateImageBuilderRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
VpcConfig	vpcConfig() The VPC configuration for the image builder.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

A unique name for the image builder.

Returns:

A unique name for the image builder.

imageName

public String imageName()

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

Returns:

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

imageArn

public String imageArn()

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

Returns:

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

instanceType

public String instanceType()

The instance type to use when launching the image builder. The following instance types are available:

• 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.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

Returns:

The instance type to use when launching the image builder. The following instance types are available:

• 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.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

description

public String description()

The description to display.

Returns:

The description to display.

displayName

public String displayName()

The image builder name to display.

Returns:

The image builder name to display.

vpcConfig

public VpcConfig vpcConfig()

The VPC configuration for the image builder. You can specify only one subnet.

Returns:

The VPC configuration for the image builder. You can specify only one subnet.

iamRoleArn

public String iamRoleArn()

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) 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:

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) 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.

enableDefaultInternetAccess

public Boolean enableDefaultInternetAccess()

Enables or disables default internet access for the image builder.

Returns:

Enables or disables default internet access for the image builder.

domainJoinInfo

public DomainJoinInfo domainJoinInfo()

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

Returns:

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

appstreamAgentVersion

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

Returns:

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

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public Map<String,String> tags()

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

hasAccessEndpoints

public boolean hasAccessEndpoints()

Returns true if the AccessEndpoints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accessEndpoints

public List<AccessEndpoint> accessEndpoints()

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAccessEndpoints() to see if a value was sent in this field.

Returns:

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

toBuilder

public CreateImageBuilderRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static CreateImageBuilderRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateImageBuilderRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.