@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ImageBuilder extends Object implements Serializable, Cloneable, StructuredPojo
Describes a virtual machine that is used to create an image.
Constructor and Description |
---|
ImageBuilder() |
Modifier and Type | Method and Description |
---|---|
ImageBuilder |
clone() |
boolean |
equals(Object obj) |
List<AccessEndpoint> |
getAccessEndpoints()
The list of virtual private cloud (VPC) interface endpoint objects.
|
String |
getAppstreamAgentVersion()
The version of the AppStream 2.0 agent that is currently being used by the image builder.
|
String |
getArn()
The ARN for the image builder.
|
Date |
getCreatedTime()
The time stamp when the image builder was created.
|
String |
getDescription()
The description to display.
|
String |
getDisplayName()
The image builder name to display.
|
DomainJoinInfo |
getDomainJoinInfo()
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active
Directory domain.
|
Boolean |
getEnableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
|
String |
getIamRoleArn()
The ARN of the IAM role that is applied to the image builder.
|
String |
getImageArn()
The ARN of the image from which this builder was created.
|
List<ResourceError> |
getImageBuilderErrors()
The image builder errors.
|
String |
getInstanceType()
The instance type for the image builder.
|
String |
getName()
The name of the image builder.
|
NetworkAccessConfiguration |
getNetworkAccessConfiguration() |
String |
getPlatform()
The operating system platform of the image builder.
|
String |
getState()
The state of the image builder.
|
ImageBuilderStateChangeReason |
getStateChangeReason()
The reason why the last state change occurred.
|
VpcConfig |
getVpcConfig()
The VPC configuration of the image builder.
|
int |
hashCode() |
Boolean |
isEnableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccessEndpoints(Collection<AccessEndpoint> accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects.
|
void |
setAppstreamAgentVersion(String appstreamAgentVersion)
The version of the AppStream 2.0 agent that is currently being used by the image builder.
|
void |
setArn(String arn)
The ARN for the image builder.
|
void |
setCreatedTime(Date createdTime)
The time stamp when the image builder was created.
|
void |
setDescription(String description)
The description to display.
|
void |
setDisplayName(String displayName)
The image builder name to display.
|
void |
setDomainJoinInfo(DomainJoinInfo domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active
Directory domain.
|
void |
setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the image builder.
|
void |
setIamRoleArn(String iamRoleArn)
The ARN of the IAM role that is applied to the image builder.
|
void |
setImageArn(String imageArn)
The ARN of the image from which this builder was created.
|
void |
setImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
The image builder errors.
|
void |
setInstanceType(String instanceType)
The instance type for the image builder.
|
void |
setName(String name)
The name of the image builder.
|
void |
setNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration) |
void |
setPlatform(String platform)
The operating system platform of the image builder.
|
void |
setState(String state)
The state of the image builder.
|
void |
setStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
The reason why the last state change occurred.
|
void |
setVpcConfig(VpcConfig vpcConfig)
The VPC configuration of the image builder.
|
String |
toString()
Returns a string representation of this object.
|
ImageBuilder |
withAccessEndpoints(AccessEndpoint... accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects.
|
ImageBuilder |
withAccessEndpoints(Collection<AccessEndpoint> accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects.
|
ImageBuilder |
withAppstreamAgentVersion(String appstreamAgentVersion)
The version of the AppStream 2.0 agent that is currently being used by the image builder.
|
ImageBuilder |
withArn(String arn)
The ARN for the image builder.
|
ImageBuilder |
withCreatedTime(Date createdTime)
The time stamp when the image builder was created.
|
ImageBuilder |
withDescription(String description)
The description to display.
|
ImageBuilder |
withDisplayName(String displayName)
The image builder name to display.
|
ImageBuilder |
withDomainJoinInfo(DomainJoinInfo domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active
Directory domain.
|
ImageBuilder |
withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the image builder.
|
ImageBuilder |
withIamRoleArn(String iamRoleArn)
The ARN of the IAM role that is applied to the image builder.
|
ImageBuilder |
withImageArn(String imageArn)
The ARN of the image from which this builder was created.
|
ImageBuilder |
withImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
The image builder errors.
|
ImageBuilder |
withImageBuilderErrors(ResourceError... imageBuilderErrors)
The image builder errors.
|
ImageBuilder |
withInstanceType(String instanceType)
The instance type for the image builder.
|
ImageBuilder |
withName(String name)
The name of the image builder.
|
ImageBuilder |
withNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration) |
ImageBuilder |
withPlatform(PlatformType platform)
The operating system platform of the image builder.
|
ImageBuilder |
withPlatform(String platform)
The operating system platform of the image builder.
|
ImageBuilder |
withState(ImageBuilderState state)
The state of the image builder.
|
ImageBuilder |
withState(String state)
The state of the image builder.
|
ImageBuilder |
withStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
The reason why the last state change occurred.
|
ImageBuilder |
withVpcConfig(VpcConfig vpcConfig)
The VPC configuration of the image builder.
|
public void setName(String name)
The name of the image builder.
name
- The name of the image builder.public String getName()
The name of the image builder.
public ImageBuilder withName(String name)
The name of the image builder.
name
- The name of the image builder.public void setArn(String arn)
The ARN for the image builder.
arn
- The ARN for the image builder.public String getArn()
The ARN for the image builder.
public ImageBuilder withArn(String arn)
The ARN for the image builder.
arn
- The ARN for the image builder.public void setImageArn(String imageArn)
The ARN of the image from which this builder was created.
imageArn
- The ARN of the image from which this builder was created.public String getImageArn()
The ARN of the image from which this builder was created.
public ImageBuilder withImageArn(String imageArn)
The ARN of the image from which this builder was created.
imageArn
- The ARN of the image from which this builder was created.public void setDescription(String description)
The description to display.
description
- The description to display.public String getDescription()
The description to display.
public ImageBuilder withDescription(String description)
The description to display.
description
- The description to display.public void setDisplayName(String displayName)
The image builder name to display.
displayName
- The image builder name to display.public String getDisplayName()
The image builder name to display.
public ImageBuilder withDisplayName(String displayName)
The image builder name to display.
displayName
- The image builder name to display.public void setVpcConfig(VpcConfig vpcConfig)
The VPC configuration of the image builder.
vpcConfig
- The VPC configuration of the image builder.public VpcConfig getVpcConfig()
The VPC configuration of the image builder.
public ImageBuilder withVpcConfig(VpcConfig vpcConfig)
The VPC configuration of the image builder.
vpcConfig
- The VPC configuration of the image builder.public void setInstanceType(String instanceType)
The instance type for 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
instanceType
- The instance type for 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
public String getInstanceType()
The instance type for 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 ImageBuilder withInstanceType(String instanceType)
The instance type for 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
instanceType
- The instance type for 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
public void setPlatform(String platform)
The operating system platform of the image builder.
platform
- The operating system platform of the image builder.PlatformType
public String getPlatform()
The operating system platform of the image builder.
PlatformType
public ImageBuilder withPlatform(String platform)
The operating system platform of the image builder.
platform
- The operating system platform of the image builder.PlatformType
public ImageBuilder withPlatform(PlatformType platform)
The operating system platform of the image builder.
platform
- The operating system platform of the image builder.PlatformType
public void setIamRoleArn(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 (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.
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 (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.
public String getIamRoleArn()
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 (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 ImageBuilder withIamRoleArn(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 (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.
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 (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.
public void setState(String state)
The state of the image builder.
state
- The state of the image builder.ImageBuilderState
public String getState()
The state of the image builder.
ImageBuilderState
public ImageBuilder withState(String state)
The state of the image builder.
state
- The state of the image builder.ImageBuilderState
public ImageBuilder withState(ImageBuilderState state)
The state of the image builder.
state
- The state of the image builder.ImageBuilderState
public void setStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
The reason why the last state change occurred.
stateChangeReason
- The reason why the last state change occurred.public ImageBuilderStateChangeReason getStateChangeReason()
The reason why the last state change occurred.
public ImageBuilder withStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
The reason why the last state change occurred.
stateChangeReason
- The reason why the last state change occurred.public void setCreatedTime(Date createdTime)
The time stamp when the image builder was created.
createdTime
- The time stamp when the image builder was created.public Date getCreatedTime()
The time stamp when the image builder was created.
public ImageBuilder withCreatedTime(Date createdTime)
The time stamp when the image builder was created.
createdTime
- The time stamp when the image builder was created.public void setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the image builder.
enableDefaultInternetAccess
- Enables or disables default internet access for the image builder.public Boolean getEnableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
public ImageBuilder withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
Enables or disables default internet access for the image builder.
enableDefaultInternetAccess
- Enables or disables default internet access for the image builder.public Boolean isEnableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
public void setDomainJoinInfo(DomainJoinInfo domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
domainJoinInfo
- The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft
Active Directory domain.public DomainJoinInfo getDomainJoinInfo()
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
public ImageBuilder withDomainJoinInfo(DomainJoinInfo domainJoinInfo)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
domainJoinInfo
- The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft
Active Directory domain.public void setNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)
networkAccessConfiguration
- public NetworkAccessConfiguration getNetworkAccessConfiguration()
public ImageBuilder withNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)
networkAccessConfiguration
- public List<ResourceError> getImageBuilderErrors()
The image builder errors.
public void setImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
The image builder errors.
imageBuilderErrors
- The image builder errors.public ImageBuilder withImageBuilderErrors(ResourceError... imageBuilderErrors)
The image builder errors.
NOTE: This method appends the values to the existing list (if any). Use
setImageBuilderErrors(java.util.Collection)
or withImageBuilderErrors(java.util.Collection)
if
you want to override the existing values.
imageBuilderErrors
- The image builder errors.public ImageBuilder withImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
The image builder errors.
imageBuilderErrors
- The image builder errors.public void setAppstreamAgentVersion(String appstreamAgentVersion)
The version of the AppStream 2.0 agent that is currently being used by the image builder.
appstreamAgentVersion
- The version of the AppStream 2.0 agent that is currently being used by the image builder.public String getAppstreamAgentVersion()
The version of the AppStream 2.0 agent that is currently being used by the image builder.
public ImageBuilder withAppstreamAgentVersion(String appstreamAgentVersion)
The version of the AppStream 2.0 agent that is currently being used by the image builder.
appstreamAgentVersion
- The version of the AppStream 2.0 agent that is currently being used by the image builder.public List<AccessEndpoint> getAccessEndpoints()
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
public void setAccessEndpoints(Collection<AccessEndpoint> accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
accessEndpoints
- The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the
image builder only through the specified endpoints.public ImageBuilder withAccessEndpoints(AccessEndpoint... accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
NOTE: This method appends the values to the existing list (if any). Use
setAccessEndpoints(java.util.Collection)
or withAccessEndpoints(java.util.Collection)
if you
want to override the existing values.
accessEndpoints
- The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the
image builder only through the specified endpoints.public ImageBuilder withAccessEndpoints(Collection<AccessEndpoint> accessEndpoints)
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
accessEndpoints
- The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the
image builder only through the specified endpoints.public String toString()
toString
in class Object
Object.toString()
public ImageBuilder clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.