Class: Aws::ECS::Types::RegisterContainerInstanceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass RegisterContainerInstanceRequest data as a hash:

{
  cluster: "String",
  instance_identity_document: "String",
  instance_identity_document_signature: "String",
  total_resources: [
    {
      name: "String",
      type: "String",
      double_value: 1.0,
      long_value: 1,
      integer_value: 1,
      string_set_value: ["String"],
    },
  ],
  version_info: {
    agent_version: "String",
    agent_hash: "String",
    docker_version: "String",
  },
  container_instance_arn: "String",
  attributes: [
    {
      name: "String", # required
      value: "String",
      target_type: "container-instance", # accepts container-instance
      target_id: "String",
    },
  ],
  platform_devices: [
    {
      id: "String", # required
      type: "GPU", # required, accepts GPU
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::Attribute>

The container instance attributes that this container instance supports.

Returns:


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#clusterString

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.

Returns:

  • (String)

7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#container_instance_arnString

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

Returns:

  • (String)

7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_identity_documentString

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: `curl 169.254.169.254/latest/dynamic/instance-identity/document/`

Returns:

  • (String)

7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_identity_document_signatureString

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 169.254.169.254/latest/dynamic/instance-identity/signature/`

Returns:

  • (String)

7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#platform_devicesArray<Types::PlatformDevice>

The devices that are available on the container instance. The only supported device type is a GPU.

Returns:


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

Returns:


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#total_resourcesArray<Types::Resource>

The resources available on the instance.

Returns:


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#version_infoTypes::VersionInfo

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

Returns:


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
# File 'lib/aws-sdk-ecs/types.rb', line 7847

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes,
  :platform_devices,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end