/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ecs.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RegisterContainerInstanceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String cluster; /** *
* 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/
*
* 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/
*
* The resources available on the instance. *
*/ private com.amazonaws.internal.SdkInternalList* The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance. *
*/ private VersionInfo versionInfo; /** ** The ARN of the container instance (if it was previously registered). *
*/ private String containerInstanceArn; /** ** The container instance attributes that this container instance supports. *
*/ private com.amazonaws.internal.SdkInternalList* The devices that are available on the container instance. The only supported device type is a GPU. *
*/ private com.amazonaws.internal.SdkInternalList* 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.
*
* 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. *
* * @param 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 void setCluster(String cluster) { this.cluster = 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. *
* * @return 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 String getCluster() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withCluster(String cluster) { setCluster(cluster); return this; } /** *
* 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 void setInstanceIdentityDocument(String instanceIdentityDocument) {
this.instanceIdentityDocument = 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 String getInstanceIdentityDocument() {
return this.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/
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegisterContainerInstanceRequest withInstanceIdentityDocument(String instanceIdentityDocument) {
setInstanceIdentityDocument(instanceIdentityDocument);
return this;
}
/**
*
* 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 void setInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) {
this.instanceIdentityDocumentSignature = 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 String getInstanceIdentityDocumentSignature() {
return this.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/
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegisterContainerInstanceRequest withInstanceIdentityDocumentSignature(String instanceIdentityDocumentSignature) {
setInstanceIdentityDocumentSignature(instanceIdentityDocumentSignature);
return this;
}
/**
* * The resources available on the instance. *
* * @return The resources available on the instance. */ public java.util.List* The resources available on the instance. *
* * @param totalResources * The resources available on the instance. */ public void setTotalResources(java.util.Collection* The resources available on the instance. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTotalResources(java.util.Collection)} or {@link #withTotalResources(java.util.Collection)} if you want * to override the existing values. *
* * @param totalResources * The resources available on the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withTotalResources(Resource... totalResources) { if (this.totalResources == null) { setTotalResources(new com.amazonaws.internal.SdkInternalList* The resources available on the instance. *
* * @param totalResources * The resources available on the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withTotalResources(java.util.Collection* The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance. *
* * @param versionInfo * The version information for the Amazon ECS container agent and Docker daemon that runs on the container * instance. */ public void setVersionInfo(VersionInfo versionInfo) { this.versionInfo = versionInfo; } /** ** The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance. *
* * @return The version information for the Amazon ECS container agent and Docker daemon that runs on the container * instance. */ public VersionInfo getVersionInfo() { return this.versionInfo; } /** ** The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance. *
* * @param versionInfo * The version information for the Amazon ECS container agent and Docker daemon that runs on the container * instance. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withVersionInfo(VersionInfo versionInfo) { setVersionInfo(versionInfo); return this; } /** ** The ARN of the container instance (if it was previously registered). *
* * @param containerInstanceArn * The ARN of the container instance (if it was previously registered). */ public void setContainerInstanceArn(String containerInstanceArn) { this.containerInstanceArn = containerInstanceArn; } /** ** The ARN of the container instance (if it was previously registered). *
* * @return The ARN of the container instance (if it was previously registered). */ public String getContainerInstanceArn() { return this.containerInstanceArn; } /** ** The ARN of the container instance (if it was previously registered). *
* * @param containerInstanceArn * The ARN of the container instance (if it was previously registered). * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withContainerInstanceArn(String containerInstanceArn) { setContainerInstanceArn(containerInstanceArn); return this; } /** ** The container instance attributes that this container instance supports. *
* * @return The container instance attributes that this container instance supports. */ public java.util.List* The container instance attributes that this container instance supports. *
* * @param attributes * The container instance attributes that this container instance supports. */ public void setAttributes(java.util.Collection* The container instance attributes that this container instance supports. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttributes(java.util.Collection)} or {@link #withAttributes(java.util.Collection)} if you want to * override the existing values. *
* * @param attributes * The container instance attributes that this container instance supports. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withAttributes(Attribute... attributes) { if (this.attributes == null) { setAttributes(new com.amazonaws.internal.SdkInternalList* The container instance attributes that this container instance supports. *
* * @param attributes * The container instance attributes that this container instance supports. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withAttributes(java.util.Collection* The devices that are available on the container instance. The only supported device type is a GPU. *
* * @return The devices that are available on the container instance. The only supported device type is a GPU. */ public java.util.List* The devices that are available on the container instance. The only supported device type is a GPU. *
* * @param platformDevices * The devices that are available on the container instance. The only supported device type is a GPU. */ public void setPlatformDevices(java.util.Collection* The devices that are available on the container instance. The only supported device type is a GPU. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setPlatformDevices(java.util.Collection)} or {@link #withPlatformDevices(java.util.Collection)} if you * want to override the existing values. *
* * @param platformDevices * The devices that are available on the container instance. The only supported device type is a GPU. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withPlatformDevices(PlatformDevice... platformDevices) { if (this.platformDevices == null) { setPlatformDevices(new com.amazonaws.internal.SdkInternalList* The devices that are available on the container instance. The only supported device type is a GPU. *
* * @param platformDevices * The devices that are available on the container instance. The only supported device type is a GPU. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterContainerInstanceRequest withPlatformDevices(java.util.Collection* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param 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.
*
* 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.
*
* 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.
*