Package software.amazon.awssdk.services.ecs.model

Interface ContainerInstance.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerInstance.Builder,ContainerInstance>, SdkBuilder<ContainerInstance.Builder,ContainerInstance>, SdkPojo
Enclosing class:
ContainerInstance
public static interface ContainerInstance.Builder extends SdkPojo, CopyableBuilder<ContainerInstance.Builder,ContainerInstance>

  • Method Details

    • containerInstanceArn

      ContainerInstance.Builder containerInstanceArn(String containerInstanceArn)

      The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

      Parameters:
      containerInstanceArn - The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ec2InstanceId

      ContainerInstance.Builder ec2InstanceId(String ec2InstanceId)

      The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

      Parameters:
      ec2InstanceId - The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderName

      ContainerInstance.Builder capacityProviderName(String capacityProviderName)

      The capacity provider that's associated with the container instance.

      Parameters:
      capacityProviderName - The capacity provider that's associated with the container instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      ContainerInstance.Builder version(Long version)

      The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

      Parameters:
      version - The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionInfo

      ContainerInstance.Builder versionInfo(VersionInfo versionInfo)

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

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

    • versionInfo

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

      The version information for the Amazon ECS container agent and Docker daemon running 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:

    • remainingResources

      ContainerInstance.Builder remainingResources(Collection<Resource> remainingResources)

      For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

      Parameters:
      remainingResources - For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remainingResources

      ContainerInstance.Builder remainingResources(Resource... remainingResources)

      For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

      Parameters:
      remainingResources - For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remainingResources

      ContainerInstance.Builder remainingResources(Consumer<Resource.Builder>... remainingResources)

      For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.

      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 remainingResources(List<Resource>).

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

    • registeredResources

      ContainerInstance.Builder registeredResources(Collection<Resource> registeredResources)

      For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

      Parameters:
      registeredResources - For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registeredResources

      ContainerInstance.Builder registeredResources(Resource... registeredResources)

      For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

      Parameters:
      registeredResources - For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registeredResources

      ContainerInstance.Builder registeredResources(Consumer<Resource.Builder>... registeredResources)

      For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

      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 registeredResources(List<Resource>).

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

    • status

      ContainerInstance.Builder status(String status)

      The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

      If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

      The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      status - The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

      If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

      The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

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

    • statusReason

      ContainerInstance.Builder statusReason(String statusReason)

      The reason that the container instance reached its current status.

      Parameters:
      statusReason - The reason that the container instance reached its current status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentConnected

      ContainerInstance.Builder agentConnected(Boolean agentConnected)

      This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

      Parameters:
      agentConnected - This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runningTasksCount

      ContainerInstance.Builder runningTasksCount(Integer runningTasksCount)

      The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.

      Parameters:
      runningTasksCount - The number of tasks on the container instance that have a desired status (desiredStatus) of RUNNING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingTasksCount

      ContainerInstance.Builder pendingTasksCount(Integer pendingTasksCount)

      The number of tasks on the container instance that are in the PENDING status.

      Parameters:
      pendingTasksCount - The number of tasks on the container instance that are in the PENDING status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentUpdateStatus

      ContainerInstance.Builder agentUpdateStatus(String agentUpdateStatus)

      The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

      Parameters:
      agentUpdateStatus - The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentUpdateStatus

      ContainerInstance.Builder agentUpdateStatus(AgentUpdateStatus agentUpdateStatus)

      The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.

      Parameters:
      agentUpdateStatus - The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attributes

      ContainerInstance.Builder attributes(Collection<Attribute> attributes)

      The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

      Parameters:
      attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      ContainerInstance.Builder attributes(Attribute... attributes)

      The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

      Parameters:
      attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

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

      The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

      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:

    • registeredAt

      ContainerInstance.Builder registeredAt(Instant registeredAt)

      The Unix timestamp for the time when the container instance was registered.

      Parameters:
      registeredAt - The Unix timestamp for the time when the container instance was registered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ContainerInstance.Builder attachments(Collection<Attachment> attachments)

      The resources attached to a container instance, such as an elastic network interface.

      Parameters:
      attachments - The resources attached to a container instance, such as an elastic network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ContainerInstance.Builder attachments(Attachment... attachments)

      The resources attached to a container instance, such as an elastic network interface.

      Parameters:
      attachments - The resources attached to a container instance, such as an elastic network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      ContainerInstance.Builder attachments(Consumer<Attachment.Builder>... attachments)

      The resources attached to a container instance, such as an elastic network interface.

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

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

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

    • tags

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

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

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

    • healthStatus

      ContainerInstance.Builder healthStatus(ContainerInstanceHealthStatus healthStatus)

      An object representing the health status of the container instance.

      Parameters:
      healthStatus - An object representing the health status of the container instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthStatus

      default ContainerInstance.Builder healthStatus(Consumer<ContainerInstanceHealthStatus.Builder> healthStatus)

      An object representing the health status of the container instance.

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

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

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