software.amazon.awssdk.services.ecs.model

Class RegisterContainerInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.RegisterContainerInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterContainerInstanceRequest
extends EcsRequest
implements ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterContainerInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<Attribute>	attributes() The container instance attributes that this container instance supports.
static RegisterContainerInstanceRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance.
String	containerInstanceArn() The ARN of the container instance (if it was previously registered).
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	instanceIdentityDocument() The instance identity document for the EC2 instance to register.
String	instanceIdentityDocumentSignature() The instance identity document signature for the EC2 instance to register.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterContainerInstanceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The metadata that you apply to the container instance to help you categorize and organize them.
RegisterContainerInstanceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<Resource>	totalResources() The resources available on the instance.
VersionInfo	versionInfo() The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cluster

public 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.

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.

instanceIdentityDocument

public 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/

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/

instanceIdentityDocumentSignature

public 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/

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/

totalResources

public List<Resource> totalResources()

The resources available on the instance.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The resources available on the instance.

versionInfo

public VersionInfo versionInfo()

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.

containerInstanceArn

public String containerInstanceArn()

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

Returns:

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

attributes

public List<Attribute> attributes()

The container instance attributes that this container instance supports.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The container instance attributes that this container instance supports.

tags

public List<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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

toBuilder

public RegisterContainerInstanceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>

Specified by:

toBuilder in class EcsRequest

Returns:

a builder for type T

builder

public static RegisterContainerInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterContainerInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.