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",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Array<Types::Attribute>

The container instance attributes that this container instance supports.

Returns:



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#cluster ⇒ String

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:

  • (String) 


4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#container_instance_arn ⇒ String

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

Returns:

  • (String) 


4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#instance_identity_document ⇒ String

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) 


4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#instance_identity_document_signature ⇒ String

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) 


4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#platform_devices ⇒ Array<Types::PlatformDevice>

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

Returns:



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#tags ⇒ Array<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, 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.

Returns:



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#total_resources ⇒ Array<Types::Resource>

The resources available on the instance.

Returns:



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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

#version_info ⇒ Types::VersionInfo

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

Returns:



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/aws-sdk-ecs/types.rb', line 4626

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