You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::Attribute>

The container instance attributes that this container instance supports.

Returns:



2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

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

#clusterString

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)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

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

#container_instance_arnString

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

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes)
  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 http://169.254.169.254/latest/dynamic/instance-identity/document/

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

class RegisterContainerInstanceRequest < Struct.new(
  :cluster,
  :instance_identity_document,
  :instance_identity_document_signature,
  :total_resources,
  :version_info,
  :container_instance_arn,
  :attributes)
  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 http://169.254.169.254/latest/dynamic/instance-identity/signature/

Returns:

  • (String)


2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

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

#total_resourcesArray<Types::Resource>

The resources available on the instance.

Returns:



2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

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

#version_infoTypes::VersionInfo

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

Returns:



2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2975

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