paws.compute (version 0.1.0)

ecs_register_container_instance: This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent

Description

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Usage

ecs_register_container_instance(cluster, instanceIdentityDocument,
  instanceIdentityDocumentSignature, totalResources, versionInfo,
  containerInstanceArn, attributes, platformDevices, tags)

Arguments

cluster

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.

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/

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/

totalResources

The resources available on the instance.

versionInfo

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

containerInstanceArn

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

attributes

The container instance attributes that this container instance supports.

platformDevices

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

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, 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.

Request syntax

svc$register_container_instance(
  cluster = "string",
  instanceIdentityDocument = "string",
  instanceIdentityDocumentSignature = "string",
  totalResources = list(
    list(
      name = "string",
      type = "string",
      doubleValue = 123.0,
      longValue = 123,
      integerValue = 123,
      stringSetValue = list(
        "string"
      )
    )
  ),
  versionInfo = list(
    agentVersion = "string",
    agentHash = "string",
    dockerVersion = "string"
  ),
  containerInstanceArn = "string",
  attributes = list(
    list(
      name = "string",
      value = "string",
      targetType = "container-instance",
      targetId = "string"
    )
  ),
  platformDevices = list(
    list(
      id = "string",
      type = "GPU"
    )
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)

Details

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.