@Generated(value="software.amazon.awssdk:codegen") public final class CreateImageBuilderRequest extends AppStreamRequest implements ToCopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateImageBuilderRequest.Builder |
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.
|
overrideConfiguration
copy
public final String name()
A unique name for the image builder.
public final String imageName()
The name of the image used to create the image builder.
public final String imageArn()
The ARN of the public, private, or shared image to use.
public final 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
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
public final String description()
The description to display.
public final String displayName()
The image builder name to display.
public final VpcConfig vpcConfig()
The VPC configuration for the image builder. You can specify only one subnet.
public final 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.
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 final Boolean enableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
public final DomainJoinInfo domainJoinInfo()
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
public final 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].
public final boolean hasTags()
public final 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.
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.
public final boolean hasAccessEndpoints()
public final 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.
public CreateImageBuilderRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>
toBuilder
in class AppStreamRequest
public static CreateImageBuilderRequest.Builder builder()
public static Class<? extends CreateImageBuilderRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.