Learn R Programming

aws.ecx (version 1.0.6)

ecs_register_container_instance: Register Container Instance

Description

Register Container Instance

Usage

ecs_register_container_instance(
  cluster = NULL,
  instanceIdentityDocument = NULL,
  instanceIdentityDocumentSignature = NULL,
  totalResources = NULL,
  versionInfo = NULL,
  containerInstanceArn = NULL,
  attributes = NULL,
  platformDevices = NULL,
  tags = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Value

A list object or a character vector

Arguments

cluster

Character. The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container...

instanceIdentityDocument

Character. The instance identity document for the EC2 instance to register.

instanceIdentityDocumentSignature

Character. The instance identity document signature for the EC2 instance to register.

totalResources

List. The resources available on the instance.

versionInfo

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

containerInstanceArn

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

attributes

List. The container instance attributes that this container instance supports.

platformDevices

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

tags

List. The metadata that you apply to the container instance to help you categorize and organize them.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

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.

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