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 Summary

Modifier and Type	Method and Description
ContainerInstance.Builder	agentConnected(Boolean agentConnected) This parameter returns true if the agent is connected to Amazon ECS.
ContainerInstance.Builder	agentUpdateStatus(AgentUpdateStatus agentUpdateStatus) The status of the most recent agent update.
ContainerInstance.Builder	agentUpdateStatus(String agentUpdateStatus) The status of the most recent agent update.
ContainerInstance.Builder	attachments(Attachment... attachments) The elastic network interfaces associated with the container instance.
ContainerInstance.Builder	attachments(Collection<Attachment> attachments) The elastic network interfaces associated with the container instance.
ContainerInstance.Builder	attachments(Consumer<Attachment.Builder>... attachments) The elastic network interfaces associated with the container instance.
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.
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.
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.
ContainerInstance.Builder	containerInstanceArn(String containerInstanceArn) The Amazon Resource Name (ARN) of the container instance.
ContainerInstance.Builder	ec2InstanceId(String ec2InstanceId) The EC2 instance ID of the container instance.
ContainerInstance.Builder	pendingTasksCount(Integer pendingTasksCount) The number of tasks on the container instance that are in the PENDING status.
ContainerInstance.Builder	registeredAt(Instant registeredAt) The Unix timestamp for when the container instance was registered.
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.
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.
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.
ContainerInstance.Builder	remainingResources(Collection<Resource> remainingResources) For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.
ContainerInstance.Builder	remainingResources(Consumer<Resource.Builder>... remainingResources) For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.
ContainerInstance.Builder	remainingResources(Resource... remainingResources) For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.
ContainerInstance.Builder	runningTasksCount(Integer runningTasksCount) The number of tasks on the container instance that are in the RUNNING status.
ContainerInstance.Builder	status(String status) The status of the container instance.
ContainerInstance.Builder	tags(Collection<Tag> tags) The metadata that you apply to the container instance to help you categorize and organize them.
ContainerInstance.Builder	tags(Consumer<Tag.Builder>... tags) The metadata that you apply to the container instance to help you categorize and organize them.
ContainerInstance.Builder	tags(Tag... tags) The metadata that you apply to the container instance to help you categorize and organize them.
ContainerInstance.Builder	version(Long version) The version counter for the container instance.
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.
ContainerInstance.Builder	versionInfo(VersionInfo versionInfo) The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

containerInstanceArn

ContainerInstance.Builder containerInstanceArn(String containerInstanceArn)

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

Parameters:

containerInstanceArn - The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

Returns:

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

ec2InstanceId

ContainerInstance.Builder ec2InstanceId(String ec2InstanceId)

The EC2 instance ID of the container instance.

Parameters:

ec2InstanceId - The EC2 instance ID of 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 are 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 are 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 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:

versionInfo(VersionInfo)

remainingResources

ContainerInstance.Builder remainingResources(Collection<Resource> remainingResources)

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been 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 is 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 has not already been 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 is 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 has not already been 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 is 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 has not already been 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 is 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 has not already been 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 is not specified here is available for new tasks.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #remainingResources(List).

Parameters:

remainingResources - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#remainingResources(List)

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #registeredResources(List).

Parameters:

registeredResources - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#registeredResources(List)

status

ContainerInstance.Builder status(String status)

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not 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 ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not 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.

agentConnected

ContainerInstance.Builder agentConnected(Boolean agentConnected)

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

Parameters:

agentConnected - This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept 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 are in the RUNNING status.

Parameters:

runningTasksCount - The number of tasks on the container instance that are in the RUNNING status.

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 has never been requested, this value is NULL.

Parameters:

agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.

Returns:

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

See Also:

AgentUpdateStatus, AgentUpdateStatus

agentUpdateStatus

ContainerInstance.Builder agentUpdateStatus(AgentUpdateStatus agentUpdateStatus)

The status of the most recent agent update. If an update has never been requested, this value is NULL.

Parameters:

agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.

Returns:

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

See Also:

AgentUpdateStatus, AgentUpdateStatus

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attributes(List).

Parameters:

attributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#attributes(List)

registeredAt

ContainerInstance.Builder registeredAt(Instant registeredAt)

The Unix timestamp for when the container instance was registered.

Parameters:

registeredAt - The Unix timestamp for 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 elastic network interfaces associated with the container instance.

Parameters:

attachments - The elastic network interfaces associated with the container instance.

Returns:

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

attachments

ContainerInstance.Builder attachments(Attachment... attachments)

The elastic network interfaces associated with the container instance.

Parameters:

attachments - The elastic network interfaces associated with the container instance.

Returns:

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

attachments

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

The elastic network interfaces associated with the container instance.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attachments(List).

Parameters:

attachments - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#attachments(List)

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)