RegisterContainerInstanceRequest (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.16.42 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RegisterContainerInstanceRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasPlatformDevices()` Returns true if the PlatformDevices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTotalResources()` Returns true if the TotalResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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<PlatformDevice>`	`platformDevices()` The devices that are available on the container instance.
`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()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - cluster
```
public final 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 final 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 final 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/
  - hasTotalResources
```
public final boolean hasTotalResources()
```
    Returns true if the TotalResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - totalResources
```
public final List<Resource> totalResources()
```
    The resources available on the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTotalResources() to see if a value was sent in this field.
    
    Returns:
    
    The resources available on the instance.
  - versionInfo
```
public final 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 final 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).
  - hasAttributes
```
public final boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributes
```
public final 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.
    
    You can use hasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The container instance attributes that this container instance supports.
  - hasPlatformDevices
```
public final boolean hasPlatformDevices()
```
    Returns true if the PlatformDevices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - platformDevices
```
public final List<PlatformDevice> platformDevices()
```
    The devices that are available on the container instance. The only supported device type is a GPU.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPlatformDevices() to see if a value was sent in this field.
    
    Returns:
    
    The devices that are available on the container instance. The only supported device type is a GPU.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final 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.
    
    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 AWS 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    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.
    
    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 AWS 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.
  - toBuilder
```
public RegisterContainerInstanceRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>
    
    Specified by:
    
    toBuilder in class EcsRequest
  - builder
```
public static RegisterContainerInstanceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterContainerInstanceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterContainerInstanceRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

cluster

instanceIdentityDocument

instanceIdentityDocumentSignature

hasTotalResources

totalResources

versionInfo

containerInstanceArn

hasAttributes

attributes

hasPlatformDevices

platformDevices

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields