Interface RegisterContainerInstanceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>, EcsRequest.Builder, SdkBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RegisterContainerInstanceRequest
@Mutable @NotThreadSafe public static interface RegisterContainerInstanceRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<RegisterContainerInstanceRequest.Builder,RegisterContainerInstanceRequest>

  • Method Details

    • cluster

      RegisterContainerInstanceRequest.Builder cluster(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceIdentityDocument

      RegisterContainerInstanceRequest.Builder instanceIdentityDocument(String 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/

      Parameters:
      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/
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceIdentityDocumentSignature

      RegisterContainerInstanceRequest.Builder instanceIdentityDocumentSignature(String 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/

      Parameters:
      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/
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalResources

      RegisterContainerInstanceRequest.Builder totalResources(Collection<Resource> totalResources)

      The resources available on the instance.

      Parameters:
      totalResources - The resources available on the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalResources

      RegisterContainerInstanceRequest.Builder totalResources(Resource... totalResources)

      The resources available on the instance.

      Parameters:
      totalResources - The resources available on the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalResources

      RegisterContainerInstanceRequest.Builder totalResources(Consumer<Resource.Builder>... totalResources)

      The resources available on the instance.

      This is a convenience method that creates an instance of the Resource.Builder avoiding the need to create one manually via Resource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to totalResources(List<Resource>).

      Parameters:
      totalResources - a consumer that will call methods on Resource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • versionInfo

      RegisterContainerInstanceRequest.Builder versionInfo(VersionInfo versionInfo)

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

      Parameters:
      versionInfo - The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionInfo

      default RegisterContainerInstanceRequest.Builder versionInfo(Consumer<VersionInfo.Builder> versionInfo)

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

      This is a convenience method that creates an instance of the VersionInfo.Builder avoiding the need to create one manually via VersionInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to versionInfo(VersionInfo).

      Parameters:
      versionInfo - a consumer that will call methods on VersionInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerInstanceArn

      RegisterContainerInstanceRequest.Builder containerInstanceArn(String containerInstanceArn)

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

      Parameters:
      containerInstanceArn - The ARN of the container instance (if it was previously registered).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      RegisterContainerInstanceRequest.Builder attributes(Collection<Attribute> attributes)

      The container instance attributes that this container instance supports.

      Parameters:
      attributes - The container instance attributes that this container instance supports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      RegisterContainerInstanceRequest.Builder attributes(Attribute... attributes)

      The container instance attributes that this container instance supports.

      Parameters:
      attributes - The container instance attributes that this container instance supports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      RegisterContainerInstanceRequest.Builder attributes(Consumer<Attribute.Builder>... attributes)

      The container instance attributes that this container instance supports.

      This is a convenience method that creates an instance of the Attribute.Builder avoiding the need to create one manually via Attribute.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributes(List<Attribute>).

      Parameters:
      attributes - a consumer that will call methods on Attribute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platformDevices

      RegisterContainerInstanceRequest.Builder platformDevices(Collection<PlatformDevice> platformDevices)

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

      Parameters:
      platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformDevices

      RegisterContainerInstanceRequest.Builder platformDevices(PlatformDevice... platformDevices)

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

      Parameters:
      platformDevices - The devices that are available on the container instance. The only supported device type is a GPU.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformDevices

      RegisterContainerInstanceRequest.Builder platformDevices(Consumer<PlatformDevice.Builder>... platformDevices)

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

      This is a convenience method that creates an instance of the PlatformDevice.Builder avoiding the need to create one manually via PlatformDevice.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to platformDevices(List<PlatformDevice>).

      Parameters:
      platformDevices - a consumer that will call methods on PlatformDevice.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      RegisterContainerInstanceRequest.Builder tags(Collection<Tag> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterContainerInstanceRequest.Builder tags(Tag... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterContainerInstanceRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      RegisterContainerInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterContainerInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.