com.amazonaws.services.ecs.model

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

Container for the parameters to the RegisterContainerInstance operation.

NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.

See Also:

AmazonECS.registerContainerInstance(RegisterContainerInstanceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterContainerInstanceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RegisterContainerInstanceRequest	clone()
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with.
String	getInstanceIdentityDocument() The instance identity document for the Amazon EC2 instance to register.
String	getInstanceIdentityDocumentSignature() The instance identity document signature for the Amazon 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	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with.
void	setInstanceIdentityDocument(String instanceIdentityDocument) The instance identity document for the Amazon EC2 instance to register.
void	setInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) The instance identity document signature for the Amazon 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	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with.
RegisterContainerInstanceRequest	withInstanceIdentityDocument(String instanceIdentityDocument) The instance identity document for the Amazon EC2 instance to register.
RegisterContainerInstanceRequest	withInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) The instance identity document signature for the Amazon EC2 instance to register.
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 running on the container instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterContainerInstanceRequest

public RegisterContainerInstanceRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that you want 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 that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want 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 that you want 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 that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceIdentityDocument

public String getInstanceIdentityDocument()

The instance identity document for the Amazon 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 Amazon 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/

setInstanceIdentityDocument

public void setInstanceIdentityDocument(String instanceIdentityDocument)

The instance identity document for the Amazon 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 Amazon 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 Amazon 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 a reference to this object so that method calls can be chained together.

Parameters:

instanceIdentityDocument - The instance identity document for the Amazon 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:

A reference to this updated object so that method calls can be chained together.

getInstanceIdentityDocumentSignature

public String getInstanceIdentityDocumentSignature()

The instance identity document signature for the Amazon 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 Amazon 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/

setInstanceIdentityDocumentSignature

public void setInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature)

The instance identity document signature for the Amazon 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 Amazon 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 Amazon 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 a reference to this object so that method calls can be chained together.

Parameters:

instanceIdentityDocumentSignature - The instance identity document signature for the Amazon 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:

A reference to this updated 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.

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

Parameters:

totalResources - The resources available on the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

withTotalResources

public RegisterContainerInstanceRequest withTotalResources(Collection<Resource> totalResources)

The resources available on the instance.

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

Parameters:

totalResources - The resources available on the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withVersionInfo

public RegisterContainerInstanceRequest withVersionInfo(VersionInfo versionInfo)

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

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

Parameters:

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

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RegisterContainerInstanceRequest clone()

Overrides:

clone in class AmazonWebServiceRequest