Amazonka.ECS.RegisterContainerInstance

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

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

Creating a Request

data RegisterContainerInstance

See: newRegisterContainerInstance smart constructor.

Constructors

RegisterContainerInstance'

Fields

• attributes :: Maybe [Attribute]

  The container instance attributes that this container instance supports.

• cluster :: Maybe Text

  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.

• containerInstanceArn :: Maybe Text

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

• instanceIdentityDocument :: Maybe Text

  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 :: Maybe Text

  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 :: Maybe [PlatformDevice]

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

• tags :: Maybe [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. 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.
• totalResources :: Maybe [Resource]

  The resources available on the instance.

• versionInfo :: Maybe VersionInfo

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

Instances

ToJSON RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

toJSON :: RegisterContainerInstance -> Value

toEncoding :: RegisterContainerInstance -> Encoding

toJSONList :: [RegisterContainerInstance] -> Value

toEncodingList :: [RegisterContainerInstance] -> Encoding

ToHeaders RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

toHeaders :: RegisterContainerInstance -> [Header]

ToPath RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

toPath :: RegisterContainerInstance -> ByteString

ToQuery RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

toQuery :: RegisterContainerInstance -> QueryString

AWSRequest RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Associated Types

type AWSResponse RegisterContainerInstance

Methods

request :: (Service -> Service) -> RegisterContainerInstance -> Request RegisterContainerInstance

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterContainerInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterContainerInstance)))

Generic RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Associated Types

type Rep RegisterContainerInstance :: Type -> Type

Methods

from :: RegisterContainerInstance -> Rep RegisterContainerInstance x

to :: Rep RegisterContainerInstance x -> RegisterContainerInstance

Read RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

readsPrec :: Int -> ReadS RegisterContainerInstance

readList :: ReadS [RegisterContainerInstance]

readPrec :: ReadPrec RegisterContainerInstance

readListPrec :: ReadPrec [RegisterContainerInstance]

Show RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

showsPrec :: Int -> RegisterContainerInstance -> ShowS

show :: RegisterContainerInstance -> String

showList :: [RegisterContainerInstance] -> ShowS

NFData RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

rnf :: RegisterContainerInstance -> ()

Eq RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

(==) :: RegisterContainerInstance -> RegisterContainerInstance -> Bool

(/=) :: RegisterContainerInstance -> RegisterContainerInstance -> Bool

Hashable RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

hashWithSalt :: Int -> RegisterContainerInstance -> Int

hash :: RegisterContainerInstance -> Int

type AWSResponse RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

type AWSResponse RegisterContainerInstance = RegisterContainerInstanceResponse

type Rep RegisterContainerInstance

Defined in Amazonka.ECS.RegisterContainerInstance

type Rep RegisterContainerInstance = D1 ('MetaData "RegisterContainerInstance" "Amazonka.ECS.RegisterContainerInstance" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "RegisterContainerInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceIdentityDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "instanceIdentityDocumentSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformDevice]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "totalResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :*: S1 ('MetaSel ('Just "versionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VersionInfo)))))))

newRegisterContainerInstance :: RegisterContainerInstance

Create a value of RegisterContainerInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterContainerInstance, registerContainerInstance_attributes - The container instance attributes that this container instance supports.

$sel:cluster:RegisterContainerInstance', registerContainerInstance_cluster - 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.

RegisterContainerInstance, registerContainerInstance_containerInstanceArn - The ARN of the container instance (if it was previously registered).

$sel:instanceIdentityDocument:RegisterContainerInstance', registerContainerInstance_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/

$sel:instanceIdentityDocumentSignature:RegisterContainerInstance', registerContainerInstance_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/

$sel:platformDevices:RegisterContainerInstance', registerContainerInstance_platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.

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

$sel:totalResources:RegisterContainerInstance', registerContainerInstance_totalResources - The resources available on the instance.

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

Request Lenses

registerContainerInstance_attributes :: Lens' RegisterContainerInstance (Maybe [Attribute])

The container instance attributes that this container instance supports.

registerContainerInstance_cluster :: Lens' RegisterContainerInstance (Maybe Text)

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.

registerContainerInstance_containerInstanceArn :: Lens' RegisterContainerInstance (Maybe Text)

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

registerContainerInstance_instanceIdentityDocument :: Lens' RegisterContainerInstance (Maybe Text)

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/

registerContainerInstance_instanceIdentityDocumentSignature :: Lens' RegisterContainerInstance (Maybe Text)

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/

registerContainerInstance_platformDevices :: Lens' RegisterContainerInstance (Maybe [PlatformDevice])

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

registerContainerInstance_tags :: Lens' RegisterContainerInstance (Maybe [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. 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.

registerContainerInstance_totalResources :: Lens' RegisterContainerInstance (Maybe [Resource])

The resources available on the instance.

registerContainerInstance_versionInfo :: Lens' RegisterContainerInstance (Maybe VersionInfo)

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

Destructuring the Response

data RegisterContainerInstanceResponse

See: newRegisterContainerInstanceResponse smart constructor.

Constructors

RegisterContainerInstanceResponse'

Fields

• containerInstance :: Maybe ContainerInstance

  The container instance that was registered.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

Associated Types

type Rep RegisterContainerInstanceResponse :: Type -> Type

Methods

from :: RegisterContainerInstanceResponse -> Rep RegisterContainerInstanceResponse x

to :: Rep RegisterContainerInstanceResponse x -> RegisterContainerInstanceResponse

Read RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

readsPrec :: Int -> ReadS RegisterContainerInstanceResponse

readList :: ReadS [RegisterContainerInstanceResponse]

readPrec :: ReadPrec RegisterContainerInstanceResponse

readListPrec :: ReadPrec [RegisterContainerInstanceResponse]

Show RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

showsPrec :: Int -> RegisterContainerInstanceResponse -> ShowS

show :: RegisterContainerInstanceResponse -> String

showList :: [RegisterContainerInstanceResponse] -> ShowS

NFData RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

rnf :: RegisterContainerInstanceResponse -> ()

Eq RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

Methods

(==) :: RegisterContainerInstanceResponse -> RegisterContainerInstanceResponse -> Bool

(/=) :: RegisterContainerInstanceResponse -> RegisterContainerInstanceResponse -> Bool

type Rep RegisterContainerInstanceResponse

Defined in Amazonka.ECS.RegisterContainerInstance

type Rep RegisterContainerInstanceResponse = D1 ('MetaData "RegisterContainerInstanceResponse" "Amazonka.ECS.RegisterContainerInstance" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "RegisterContainerInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterContainerInstanceResponse

Arguments

:: Int

$sel:httpStatus:RegisterContainerInstanceResponse'

-> RegisterContainerInstanceResponse

Create a value of RegisterContainerInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerInstance:RegisterContainerInstanceResponse', registerContainerInstanceResponse_containerInstance - The container instance that was registered.

$sel:httpStatus:RegisterContainerInstanceResponse', registerContainerInstanceResponse_httpStatus - The response's http status code.

Response Lenses

registerContainerInstanceResponse_containerInstance :: Lens' RegisterContainerInstanceResponse (Maybe ContainerInstance)

The container instance that was registered.

registerContainerInstanceResponse_httpStatus :: Lens' RegisterContainerInstanceResponse Int

The response's http status code.