@Generated(value="software.amazon.awssdk:codegen") public final class RegisterContainerInstanceRequest extends EcsRequest implements ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RegisterContainerInstanceRequest.Builder |
| 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 to register your container instance with.
|
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()
For responses, this returns true if the service returned a value for the Attributes property.
|
int |
hashCode() |
boolean |
hasPlatformDevices()
For responses, this returns true if the service returned a value for the PlatformDevices property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasTotalResources()
For responses, this returns true if the service returned a value for the TotalResources property.
|
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 that runs on the container instance.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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.
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/
curl http://169.254.169.254/latest/dynamic/instance-identity/document/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/
curl http://169.254.169.254/latest/dynamic/instance-identity/signature/public final boolean hasTotalResources()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTotalResources() method.
public final VersionInfo versionInfo()
The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
public final String containerInstanceArn()
The ARN of the container instance (if it was previously registered).
public final boolean hasAttributes()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAttributes() method.
public final boolean hasPlatformDevices()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPlatformDevices() method.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.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. 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public RegisterContainerInstanceRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>toBuilder in class EcsRequestpublic static RegisterContainerInstanceRequest.Builder builder()
public static Class<? extends RegisterContainerInstanceRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.