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

Interface ContainerInstance.Builder

All Superinterfaces:

CopyableBuilder<ContainerInstance.Builder,ContainerInstance>, SdkBuilder<ContainerInstance.Builder,ContainerInstance>

Enclosing class:

ContainerInstance

public static interface ContainerInstance.Builder
extends CopyableBuilder<ContainerInstance.Builder,ContainerInstance>

Method Summary

Modifier and Type	Method	Description
ContainerInstance.Builder	agentConnected(Boolean agentConnected)	This parameter returns true if the agent is actually connected to Amazon ECS.
ContainerInstance.Builder	agentUpdateStatus(String agentUpdateStatus)	The status of the most recent agent update.
ContainerInstance.Builder	agentUpdateStatus(AgentUpdateStatus agentUpdateStatus)	The status of the most recent agent update.
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(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	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(Date registeredAt)	The Unix timestamp for when the container instance was registered.
ContainerInstance.Builder	registeredResources(Collection<Resource> registeredResources)	For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks.
ContainerInstance.Builder	registeredResources(Resource... registeredResources)	For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks.
ContainerInstance.Builder	remainingResources(Collection<Resource> remainingResources)	For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks.
ContainerInstance.Builder	remainingResources(Resource... remainingResources)	For most resource types, this parameter describes the remaining resources of the container instance that are 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	version(Long version)	The version counter for 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.utils.builder.CopyableBuilder

copy

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

apply, 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.

remainingResources

ContainerInstance.Builder remainingResources(Collection<Resource> remainingResources)

For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.

Parameters:

remainingResources - For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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 most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.

NOTE: This method appends the values to the existing list (if any). Use #setRemainingResources(java.util.Collection) or #withRemainingResources(java.util.Collection) if you want to override the existing values.

Parameters:

remainingResources - For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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.

registeredResources

ContainerInstance.Builder registeredResources(Collection<Resource> registeredResources)

For most resource types, this parameter describes the registered resources on the container instance that are in use by current 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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 most resource types, this parameter describes the registered resources on the container instance that are in use by current 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.

NOTE: This method appends the values to the existing list (if any). Use #setRegisteredResources(java.util.Collection) or #withRegisteredResources(java.util.Collection) if you want to override the existing values.

Parameters:

registeredResources - For most resource types, this parameter describes the registered resources on the container instance that are in use by current 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.

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 EC2 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 EC2 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 actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.

Parameters:

agentConnected - This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot 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

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setAttributes(java.util.Collection) or #withAttributes(java.util.Collection) if you want to override the existing values.

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.

registeredAt

ContainerInstance.Builder registeredAt(Date 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.