Skip to content

RegisterContainerInstanceRequest

Source code in docs_src/capo_ecs/types/register_container_instance_request.py
class RegisterContainerInstanceRequest(TypedDict, closed=True):
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>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.</p>"""
    instance_identity_document: NotRequired["capo_ecs.types.string.String"]
    """<p>The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: <code>curl http://169.254.169.254/latest/dynamic/instance-identity/document/</code> </p>"""
    instance_identity_document_signature: NotRequired["capo_ecs.types.string.String"]
    """<p>The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: <code>curl http://169.254.169.254/latest/dynamic/instance-identity/signature/</code> </p>"""
    total_resources: NotRequired["capo_ecs.types.resources.Resources"]
    """<p>The resources available on the instance.</p>"""
    version_info: NotRequired["capo_ecs.types.version_info.VersionInfo"]
    """<p>The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.</p>"""
    container_instance_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The ARN of the container instance (if it was previously registered).</p>"""
    attributes: NotRequired["capo_ecs.types.attributes.Attributes"]
    """<p>The container instance attributes that this container instance supports.</p>"""
    platform_devices: NotRequired["capo_ecs.types.platform_devices.PlatformDevices"]
    """<p>The devices that are available on the container instance. The supported device types are GPUs and Neuron devices.</p>"""
    tags: NotRequired["capo_ecs.types.tags.Tags"]
    """<p>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.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>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: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p> </li> </ul>"""

attributes instance-attribute

attributes: NotRequired[Attributes]

The container instance attributes that this container instance supports.

cluster instance-attribute

cluster: NotRequired[String]

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.

container_instance_arn instance-attribute

container_instance_arn: NotRequired[String]

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

instance_identity_document instance-attribute

instance_identity_document: NotRequired[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 http://169.254.169.254/latest/dynamic/instance-identity/document/

instance_identity_document_signature instance-attribute

instance_identity_document_signature: NotRequired[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 http://169.254.169.254/latest/dynamic/instance-identity/signature/

platform_devices instance-attribute

platform_devices: NotRequired[PlatformDevices]

The devices that are available on the container instance. The supported device types are GPUs and Neuron devices.

tags instance-attribute

tags: NotRequired[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. 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.

total_resources instance-attribute

total_resources: NotRequired[Resources]

The resources available on the instance.

version_info instance-attribute

version_info: NotRequired[VersionInfo]

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