com.amazonaws.services.ecs.model

Class RegisterContainerInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RegisterContainerInstanceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterContainerInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterContainerInstanceRequest()

Method Summary

Modifier and Type	Method and Description
RegisterContainerInstanceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Attribute>	getAttributes() The container instance attributes that this container instance supports.
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with.
String	getContainerInstanceArn() The ARN of the container instance (if it was previously registered).
String	getInstanceIdentityDocument() The instance identity document for the EC2 instance to register.
String	getInstanceIdentityDocumentSignature() The instance identity document signature for the EC2 instance to register.
List<PlatformDevice>	getPlatformDevices() The devices that are available on the container instance.
List<Tag>	getTags() The metadata that you apply to the container instance to help you categorize and organize them.
List<Resource>	getTotalResources() The resources available on the instance.
VersionInfo	getVersionInfo() The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
int	hashCode()
void	setAttributes(Collection<Attribute> attributes) The container instance attributes that this container instance supports.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with.
void	setContainerInstanceArn(String containerInstanceArn) The ARN of the container instance (if it was previously registered).
void	setInstanceIdentityDocument(String instanceIdentityDocument) The instance identity document for the EC2 instance to register.
void	setInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) The instance identity document signature for the EC2 instance to register.
void	setPlatformDevices(Collection<PlatformDevice> platformDevices) The devices that are available on the container instance.
void	setTags(Collection<Tag> tags) The metadata that you apply to the container instance to help you categorize and organize them.
void	setTotalResources(Collection<Resource> totalResources) The resources available on the instance.
void	setVersionInfo(VersionInfo versionInfo) The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
String	toString() Returns a string representation of this object.
RegisterContainerInstanceRequest	withAttributes(Attribute... attributes) The container instance attributes that this container instance supports.
RegisterContainerInstanceRequest	withAttributes(Collection<Attribute> attributes) The container instance attributes that this container instance supports.
RegisterContainerInstanceRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with.
RegisterContainerInstanceRequest	withContainerInstanceArn(String containerInstanceArn) The ARN of the container instance (if it was previously registered).
RegisterContainerInstanceRequest	withInstanceIdentityDocument(String instanceIdentityDocument) The instance identity document for the EC2 instance to register.
RegisterContainerInstanceRequest	withInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) The instance identity document signature for the EC2 instance to register.
RegisterContainerInstanceRequest	withPlatformDevices(Collection<PlatformDevice> platformDevices) The devices that are available on the container instance.
RegisterContainerInstanceRequest	withPlatformDevices(PlatformDevice... platformDevices) The devices that are available on the container instance.
RegisterContainerInstanceRequest	withTags(Collection<Tag> tags) The metadata that you apply to the container instance to help you categorize and organize them.
RegisterContainerInstanceRequest	withTags(Tag... tags) The metadata that you apply to the container instance to help you categorize and organize them.
RegisterContainerInstanceRequest	withTotalResources(Collection<Resource> totalResources) The resources available on the instance.
RegisterContainerInstanceRequest	withTotalResources(Resource... totalResources) The resources available on the instance.
RegisterContainerInstanceRequest	withVersionInfo(VersionInfo versionInfo) The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterContainerInstanceRequest

public RegisterContainerInstanceRequest()

Method Detail

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

withCluster

public RegisterContainerInstanceRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceIdentityDocument

public void setInstanceIdentityDocument(String instanceIdentityDocument)

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

Parameters:

instanceIdentityDocument - The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

getInstanceIdentityDocument

public String getInstanceIdentityDocument()

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

Returns:

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

withInstanceIdentityDocument

public RegisterContainerInstanceRequest withInstanceIdentityDocument(String instanceIdentityDocument)

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

Parameters:

instanceIdentityDocument - The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceIdentityDocumentSignature

public void setInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature)

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

Parameters:

instanceIdentityDocumentSignature - The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

getInstanceIdentityDocumentSignature

public String getInstanceIdentityDocumentSignature()

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

Returns:

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

withInstanceIdentityDocumentSignature

public RegisterContainerInstanceRequest withInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature)

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

Parameters:

instanceIdentityDocumentSignature - The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

Returns:

Returns a reference to this object so that method calls can be chained together.

getTotalResources

public List<Resource> getTotalResources()

The resources available on the instance.

Returns:

The resources available on the instance.

setTotalResources

public void setTotalResources(Collection<Resource> totalResources)

The resources available on the instance.

Parameters:

totalResources - The resources available on the instance.

withTotalResources

public RegisterContainerInstanceRequest withTotalResources(Resource... totalResources)

The resources available on the instance.

NOTE: This method appends the values to the existing list (if any). Use setTotalResources(java.util.Collection) or withTotalResources(java.util.Collection) if you want to override the existing values.

Parameters:

totalResources - The resources available on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTotalResources

public RegisterContainerInstanceRequest withTotalResources(Collection<Resource> totalResources)

The resources available on the instance.

Parameters:

totalResources - The resources available on the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVersionInfo

public void setVersionInfo(VersionInfo versionInfo)

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

Parameters:

versionInfo - The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

getVersionInfo

public VersionInfo getVersionInfo()

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

Returns:

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

withVersionInfo

public RegisterContainerInstanceRequest withVersionInfo(VersionInfo versionInfo)

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

Parameters:

versionInfo - The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContainerInstanceArn

public void setContainerInstanceArn(String containerInstanceArn)

The ARN of the container instance (if it was previously registered).

Parameters:

containerInstanceArn - The ARN of the container instance (if it was previously registered).

getContainerInstanceArn

public String getContainerInstanceArn()

The ARN of the container instance (if it was previously registered).

Returns:

The ARN of the container instance (if it was previously registered).

withContainerInstanceArn

public RegisterContainerInstanceRequest withContainerInstanceArn(String containerInstanceArn)

The ARN of the container instance (if it was previously registered).

Parameters:

containerInstanceArn - The ARN of the container instance (if it was previously registered).

Returns:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public List<Attribute> getAttributes()

The container instance attributes that this container instance supports.

Returns:

The container instance attributes that this container instance supports.

setAttributes

public void setAttributes(Collection<Attribute> attributes)

The container instance attributes that this container instance supports.

Parameters:

attributes - The container instance attributes that this container instance supports.

withAttributes

public RegisterContainerInstanceRequest withAttributes(Attribute... attributes)

The container instance attributes that this container instance supports.

NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

attributes - The container instance attributes that this container instance supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAttributes

public RegisterContainerInstanceRequest withAttributes(Collection<Attribute> attributes)

The container instance attributes that this container instance supports.

Parameters:

attributes - The container instance attributes that this container instance supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPlatformDevices

public List<PlatformDevice> getPlatformDevices()

The devices that are available on the container instance. The only supported device type is a GPU.

Returns:

The devices that are available on the container instance. The only supported device type is a GPU.

setPlatformDevices

public void setPlatformDevices(Collection<PlatformDevice> platformDevices)

The devices that are available on the container instance. The only supported device type is a GPU.

Parameters:

platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.

withPlatformDevices

public RegisterContainerInstanceRequest withPlatformDevices(PlatformDevice... platformDevices)

The devices that are available on the container instance. The only supported device type is a GPU.

NOTE: This method appends the values to the existing list (if any). Use setPlatformDevices(java.util.Collection) or withPlatformDevices(java.util.Collection) if you want to override the existing values.

Parameters:

platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPlatformDevices

public RegisterContainerInstanceRequest withPlatformDevices(Collection<PlatformDevice> platformDevices)

The devices that are available on the container instance. The only supported device type is a GPU.

Parameters:

platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

setTags

public void setTags(Collection<Tag> tags)

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Parameters:

tags - The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

withTags

public RegisterContainerInstanceRequest withTags(Tag... tags)

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public RegisterContainerInstanceRequest withTags(Collection<Tag> tags)

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Parameters:

tags - The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterContainerInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()