Class RegisterContainerInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RegisterContainerInstanceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterContainerInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
RegisterContainerInstanceRequest()

Method Summary

Modifier and Type	Method	Description
RegisterContainerInstanceRequest	clone()	Creates a shallow clone of this request.
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 with which to register your container instance.
String	getContainerInstanceArn()	The Amazon Resource Name (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<Resource>	getTotalResources()	The resources available on the instance.
VersionInfo	getVersionInfo()	The version information for the Amazon ECS container agent and Docker daemon running 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 with which to register your container instance.
void	setContainerInstanceArn(String containerInstanceArn)	The Amazon Resource Name (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	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 running on the container instance.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
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 with which to register your container instance.
RegisterContainerInstanceRequest	withContainerInstanceArn(String containerInstanceArn)	The Amazon Resource Name (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	withTotalResources(Resource... totalResources)	The resources available on the instance.
RegisterContainerInstanceRequest	withTotalResources(Collection<Resource> totalResources)	The resources available on the instance.
RegisterContainerInstanceRequest	withVersionInfo(VersionInfo versionInfo)	The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Methods inherited from class AmazonWebServiceRequest

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

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RegisterContainerInstanceRequest

public RegisterContainerInstanceRequest()

Method Details

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. 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 with which to register your container instance. 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 with which to register your container instance. 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 with which to register your container instance. 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 with which to register your container instance. 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 with which to register your container instance. 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 running on the container instance.

Parameters:

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

getVersionInfo

public VersionInfo getVersionInfo()

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

Returns:

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

withVersionInfo

public RegisterContainerInstanceRequest withVersionInfo(VersionInfo versionInfo)

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

Parameters:

versionInfo - The version information for the Amazon ECS container agent and Docker daemon running 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 Amazon Resource Name (ARN) of the container instance (if it was previously registered).

Parameters:

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

getContainerInstanceArn

public String getContainerInstanceArn()

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

Returns:

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

withContainerInstanceArn

public RegisterContainerInstanceRequest withContainerInstanceArn(String containerInstanceArn)

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

Parameters:

containerInstanceArn - The Amazon Resource Name (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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()