/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
⭐ Starred 171 GitHub stars
/ Paws::ECS::RegisterContainerInstance

NAME

Paws::ECS::RegisterContainerInstance - Arguments for method RegisterContainerInstance on Paws::ECS

DESCRIPTION

This class represents the parameters used for calling the method RegisterContainerInstance on the Amazon EC2 Container Service service. Use the attributes of this class as arguments to method RegisterContainerInstance.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterContainerInstance.

SYNOPSIS

my $ecs = Paws->service('ECS');
my $RegisterContainerInstanceResponse = $ecs->RegisterContainerInstance(
  Attributes => [
    {
      Name       => 'MyString',
      TargetId   => 'MyString',
      TargetType =>
        'container-instance',    # values: container-instance; OPTIONAL
      Value => 'MyString',
    },
    ...
  ],    # OPTIONAL
  Cluster                           => 'MyString',    # OPTIONAL
  ContainerInstanceArn              => 'MyString',    # OPTIONAL
  InstanceIdentityDocument          => 'MyString',    # OPTIONAL
  InstanceIdentityDocumentSignature => 'MyString',    # OPTIONAL
  PlatformDevices                   => [
    {
      Id   => 'MyString',
      Type => 'GPU',                                  # values: GPU

    },
    ...
  ],    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128; OPTIONAL
      Value => 'MyTagValue',    # max: 256; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  TotalResources => [
    {
      DoubleValue    => 1,                      # OPTIONAL
      IntegerValue   => 1,                      # OPTIONAL
      LongValue      => 1,                      # OPTIONAL
      Name           => 'MyString',
      StringSetValue => [ 'MyString', ... ],    # OPTIONAL
      Type           => 'MyString',
    },
    ...
  ],    # OPTIONAL
  VersionInfo => {
    AgentHash     => 'MyString',
    AgentVersion  => 'MyString',
    DockerVersion => 'MyString',
  },    # OPTIONAL
);

# Results:
my $ContainerInstance =
  $RegisterContainerInstanceResponse->ContainerInstance;

# Returns a L<Paws::ECS::RegisterContainerInstanceResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ecs/RegisterContainerInstance

ATTRIBUTES

Attributes => ArrayRef[Paws::ECS::Attribute]

The container instance attributes that this container instance supports.

Cluster => Str

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.

ContainerInstanceArn => Str

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

InstanceIdentityDocument => Str

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 => Str

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/

PlatformDevices => ArrayRef[Paws::ECS::PlatformDevice]

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

Tags => ArrayRef[Paws::ECS::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.

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.

TotalResources => ArrayRef[Paws::ECS::Resource]

The resources available on the instance.

VersionInfo => Paws::ECS::VersionInfo

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

SEE ALSO

This class forms part of Paws, documenting arguments for method RegisterContainerInstance in Paws::ECS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues