AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ContainerInstance Class Reference

#include <ContainerInstance.h>

Public Member Functions

 ContainerInstance ()
 
 ContainerInstance (Aws::Utils::Json::JsonView jsonValue)
 
ContainerInstanceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetContainerInstanceArn () const
 
bool ContainerInstanceArnHasBeenSet () const
 
void SetContainerInstanceArn (const Aws::String &value)
 
void SetContainerInstanceArn (Aws::String &&value)
 
void SetContainerInstanceArn (const char *value)
 
ContainerInstanceWithContainerInstanceArn (const Aws::String &value)
 
ContainerInstanceWithContainerInstanceArn (Aws::String &&value)
 
ContainerInstanceWithContainerInstanceArn (const char *value)
 
const Aws::StringGetEc2InstanceId () const
 
bool Ec2InstanceIdHasBeenSet () const
 
void SetEc2InstanceId (const Aws::String &value)
 
void SetEc2InstanceId (Aws::String &&value)
 
void SetEc2InstanceId (const char *value)
 
ContainerInstanceWithEc2InstanceId (const Aws::String &value)
 
ContainerInstanceWithEc2InstanceId (Aws::String &&value)
 
ContainerInstanceWithEc2InstanceId (const char *value)
 
const Aws::StringGetCapacityProviderName () const
 
bool CapacityProviderNameHasBeenSet () const
 
void SetCapacityProviderName (const Aws::String &value)
 
void SetCapacityProviderName (Aws::String &&value)
 
void SetCapacityProviderName (const char *value)
 
ContainerInstanceWithCapacityProviderName (const Aws::String &value)
 
ContainerInstanceWithCapacityProviderName (Aws::String &&value)
 
ContainerInstanceWithCapacityProviderName (const char *value)
 
long long GetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (long long value)
 
ContainerInstanceWithVersion (long long value)
 
const VersionInfoGetVersionInfo () const
 
bool VersionInfoHasBeenSet () const
 
void SetVersionInfo (const VersionInfo &value)
 
void SetVersionInfo (VersionInfo &&value)
 
ContainerInstanceWithVersionInfo (const VersionInfo &value)
 
ContainerInstanceWithVersionInfo (VersionInfo &&value)
 
const Aws::Vector< Resource > & GetRemainingResources () const
 
bool RemainingResourcesHasBeenSet () const
 
void SetRemainingResources (const Aws::Vector< Resource > &value)
 
void SetRemainingResources (Aws::Vector< Resource > &&value)
 
ContainerInstanceWithRemainingResources (const Aws::Vector< Resource > &value)
 
ContainerInstanceWithRemainingResources (Aws::Vector< Resource > &&value)
 
ContainerInstanceAddRemainingResources (const Resource &value)
 
ContainerInstanceAddRemainingResources (Resource &&value)
 
const Aws::Vector< Resource > & GetRegisteredResources () const
 
bool RegisteredResourcesHasBeenSet () const
 
void SetRegisteredResources (const Aws::Vector< Resource > &value)
 
void SetRegisteredResources (Aws::Vector< Resource > &&value)
 
ContainerInstanceWithRegisteredResources (const Aws::Vector< Resource > &value)
 
ContainerInstanceWithRegisteredResources (Aws::Vector< Resource > &&value)
 
ContainerInstanceAddRegisteredResources (const Resource &value)
 
ContainerInstanceAddRegisteredResources (Resource &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ContainerInstanceWithStatus (const Aws::String &value)
 
ContainerInstanceWithStatus (Aws::String &&value)
 
ContainerInstanceWithStatus (const char *value)
 
const Aws::StringGetStatusReason () const
 
bool StatusReasonHasBeenSet () const
 
void SetStatusReason (const Aws::String &value)
 
void SetStatusReason (Aws::String &&value)
 
void SetStatusReason (const char *value)
 
ContainerInstanceWithStatusReason (const Aws::String &value)
 
ContainerInstanceWithStatusReason (Aws::String &&value)
 
ContainerInstanceWithStatusReason (const char *value)
 
bool GetAgentConnected () const
 
bool AgentConnectedHasBeenSet () const
 
void SetAgentConnected (bool value)
 
ContainerInstanceWithAgentConnected (bool value)
 
int GetRunningTasksCount () const
 
bool RunningTasksCountHasBeenSet () const
 
void SetRunningTasksCount (int value)
 
ContainerInstanceWithRunningTasksCount (int value)
 
int GetPendingTasksCount () const
 
bool PendingTasksCountHasBeenSet () const
 
void SetPendingTasksCount (int value)
 
ContainerInstanceWithPendingTasksCount (int value)
 
const AgentUpdateStatusGetAgentUpdateStatus () const
 
bool AgentUpdateStatusHasBeenSet () const
 
void SetAgentUpdateStatus (const AgentUpdateStatus &value)
 
void SetAgentUpdateStatus (AgentUpdateStatus &&value)
 
ContainerInstanceWithAgentUpdateStatus (const AgentUpdateStatus &value)
 
ContainerInstanceWithAgentUpdateStatus (AgentUpdateStatus &&value)
 
const Aws::Vector< Attribute > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Vector< Attribute > &value)
 
void SetAttributes (Aws::Vector< Attribute > &&value)
 
ContainerInstanceWithAttributes (const Aws::Vector< Attribute > &value)
 
ContainerInstanceWithAttributes (Aws::Vector< Attribute > &&value)
 
ContainerInstanceAddAttributes (const Attribute &value)
 
ContainerInstanceAddAttributes (Attribute &&value)
 
const Aws::Utils::DateTimeGetRegisteredAt () const
 
bool RegisteredAtHasBeenSet () const
 
void SetRegisteredAt (const Aws::Utils::DateTime &value)
 
void SetRegisteredAt (Aws::Utils::DateTime &&value)
 
ContainerInstanceWithRegisteredAt (const Aws::Utils::DateTime &value)
 
ContainerInstanceWithRegisteredAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Attachment > & GetAttachments () const
 
bool AttachmentsHasBeenSet () const
 
void SetAttachments (const Aws::Vector< Attachment > &value)
 
void SetAttachments (Aws::Vector< Attachment > &&value)
 
ContainerInstanceWithAttachments (const Aws::Vector< Attachment > &value)
 
ContainerInstanceWithAttachments (Aws::Vector< Attachment > &&value)
 
ContainerInstanceAddAttachments (const Attachment &value)
 
ContainerInstanceAddAttachments (Attachment &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
ContainerInstanceWithTags (const Aws::Vector< Tag > &value)
 
ContainerInstanceWithTags (Aws::Vector< Tag > &&value)
 
ContainerInstanceAddTags (const Tag &value)
 
ContainerInstanceAddTags (Tag &&value)
 

Detailed Description

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

See Also:

AWS API Reference

Definition at line 40 of file ContainerInstance.h.

Constructor & Destructor Documentation

◆ ContainerInstance() [1/2]

Aws::ECS::Model::ContainerInstance::ContainerInstance ( )

◆ ContainerInstance() [2/2]

Aws::ECS::Model::ContainerInstance::ContainerInstance ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAttachments() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddAttachments ( const Attachment value)
inline

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

Definition at line 954 of file ContainerInstance.h.

◆ AddAttachments() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddAttachments ( Attachment &&  value)
inline

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

Definition at line 960 of file ContainerInstance.h.

◆ AddAttributes() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddAttributes ( const Attribute value)
inline

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

Definition at line 873 of file ContainerInstance.h.

◆ AddAttributes() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddAttributes ( Attribute &&  value)
inline

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

Definition at line 880 of file ContainerInstance.h.

◆ AddRegisteredResources() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddRegisteredResources ( const Resource value)
inline

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.

Definition at line 458 of file ContainerInstance.h.

◆ AddRegisteredResources() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddRegisteredResources ( Resource &&  value)
inline

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.

Definition at line 469 of file ContainerInstance.h.

◆ AddRemainingResources() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddRemainingResources ( const Resource value)
inline

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.

Definition at line 369 of file ContainerInstance.h.

◆ AddRemainingResources() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddRemainingResources ( Resource &&  value)
inline

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.

Definition at line 380 of file ContainerInstance.h.

◆ AddTags() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddTags ( const Tag value)
inline

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.

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

Definition at line 1101 of file ContainerInstance.h.

◆ AddTags() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::AddTags ( Tag &&  value)
inline

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.

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

Definition at line 1121 of file ContainerInstance.h.

◆ AgentConnectedHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::AgentConnectedHasBeenSet ( ) const
inline

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.

Definition at line 720 of file ContainerInstance.h.

◆ AgentUpdateStatusHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::AgentUpdateStatusHasBeenSet ( ) const
inline

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

Definition at line 799 of file ContainerInstance.h.

◆ AttachmentsHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::AttachmentsHasBeenSet ( ) const
inline

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

Definition at line 924 of file ContainerInstance.h.

◆ AttributesHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::AttributesHasBeenSet ( ) const
inline

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

Definition at line 838 of file ContainerInstance.h.

◆ CapacityProviderNameHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::CapacityProviderNameHasBeenSet ( ) const
inline

The capacity provider associated with the container instance.

Definition at line 179 of file ContainerInstance.h.

◆ ContainerInstanceArnHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::ContainerInstanceArnHasBeenSet ( ) const
inline

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.

Definition at line 67 of file ContainerInstance.h.

◆ Ec2InstanceIdHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::Ec2InstanceIdHasBeenSet ( ) const
inline

The EC2 instance ID of the container instance.

Definition at line 138 of file ContainerInstance.h.

◆ GetAgentConnected()

bool Aws::ECS::Model::ContainerInstance::GetAgentConnected ( ) const
inline

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.

Definition at line 712 of file ContainerInstance.h.

◆ GetAgentUpdateStatus()

const AgentUpdateStatus& Aws::ECS::Model::ContainerInstance::GetAgentUpdateStatus ( ) const
inline

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

Definition at line 793 of file ContainerInstance.h.

◆ GetAttachments()

const Aws::Vector<Attachment>& Aws::ECS::Model::ContainerInstance::GetAttachments ( ) const
inline

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

Definition at line 918 of file ContainerInstance.h.

◆ GetAttributes()

const Aws::Vector<Attribute>& Aws::ECS::Model::ContainerInstance::GetAttributes ( ) const
inline

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

Definition at line 831 of file ContainerInstance.h.

◆ GetCapacityProviderName()

const Aws::String& Aws::ECS::Model::ContainerInstance::GetCapacityProviderName ( ) const
inline

The capacity provider associated with the container instance.

Definition at line 174 of file ContainerInstance.h.

◆ GetContainerInstanceArn()

const Aws::String& Aws::ECS::Model::ContainerInstance::GetContainerInstanceArn ( ) const
inline

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.

Definition at line 57 of file ContainerInstance.h.

◆ GetEc2InstanceId()

const Aws::String& Aws::ECS::Model::ContainerInstance::GetEc2InstanceId ( ) const
inline

The EC2 instance ID of the container instance.

Definition at line 133 of file ContainerInstance.h.

◆ GetPendingTasksCount()

int Aws::ECS::Model::ContainerInstance::GetPendingTasksCount ( ) const
inline

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

Definition at line 768 of file ContainerInstance.h.

◆ GetRegisteredAt()

const Aws::Utils::DateTime& Aws::ECS::Model::ContainerInstance::GetRegisteredAt ( ) const
inline

The Unix timestamp for when the container instance was registered.

Definition at line 886 of file ContainerInstance.h.

◆ GetRegisteredResources()

const Aws::Vector<Resource>& Aws::ECS::Model::ContainerInstance::GetRegisteredResources ( ) const
inline

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.

Definition at line 392 of file ContainerInstance.h.

◆ GetRemainingResources()

const Aws::Vector<Resource>& Aws::ECS::Model::ContainerInstance::GetRemainingResources ( ) const
inline

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.

Definition at line 303 of file ContainerInstance.h.

◆ GetRunningTasksCount()

int Aws::ECS::Model::ContainerInstance::GetRunningTasksCount ( ) const
inline

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

Definition at line 743 of file ContainerInstance.h.

◆ GetStatus()

const Aws::String& Aws::ECS::Model::ContainerInstance::GetStatus ( ) const
inline

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

Definition at line 494 of file ContainerInstance.h.

◆ GetStatusReason()

const Aws::String& Aws::ECS::Model::ContainerInstance::GetStatusReason ( ) const
inline

The reason that the container instance reached its current status.

Definition at line 668 of file ContainerInstance.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::ContainerInstance::GetTags ( ) const
inline

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.

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

Definition at line 981 of file ContainerInstance.h.

◆ GetVersion()

long long Aws::ECS::Model::ContainerInstance::GetVersion ( ) const
inline

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.

Definition at line 221 of file ContainerInstance.h.

◆ GetVersionInfo()

const VersionInfo& Aws::ECS::Model::ContainerInstance::GetVersionInfo ( ) const
inline

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

Definition at line 261 of file ContainerInstance.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::ContainerInstance::Jsonize ( ) const

◆ operator=()

ContainerInstance& Aws::ECS::Model::ContainerInstance::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PendingTasksCountHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::PendingTasksCountHasBeenSet ( ) const
inline

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

Definition at line 774 of file ContainerInstance.h.

◆ RegisteredAtHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::RegisteredAtHasBeenSet ( ) const
inline

The Unix timestamp for when the container instance was registered.

Definition at line 891 of file ContainerInstance.h.

◆ RegisteredResourcesHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::RegisteredResourcesHasBeenSet ( ) const
inline

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.

Definition at line 403 of file ContainerInstance.h.

◆ RemainingResourcesHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::RemainingResourcesHasBeenSet ( ) const
inline

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.

Definition at line 314 of file ContainerInstance.h.

◆ RunningTasksCountHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::RunningTasksCountHasBeenSet ( ) const
inline

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

Definition at line 749 of file ContainerInstance.h.

◆ SetAgentConnected()

void Aws::ECS::Model::ContainerInstance::SetAgentConnected ( bool  value)
inline

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.

Definition at line 728 of file ContainerInstance.h.

◆ SetAgentUpdateStatus() [1/2]

void Aws::ECS::Model::ContainerInstance::SetAgentUpdateStatus ( const AgentUpdateStatus value)
inline

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

Definition at line 805 of file ContainerInstance.h.

◆ SetAgentUpdateStatus() [2/2]

void Aws::ECS::Model::ContainerInstance::SetAgentUpdateStatus ( AgentUpdateStatus &&  value)
inline

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

Definition at line 811 of file ContainerInstance.h.

◆ SetAttachments() [1/2]

void Aws::ECS::Model::ContainerInstance::SetAttachments ( const Aws::Vector< Attachment > &  value)
inline

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

Definition at line 930 of file ContainerInstance.h.

◆ SetAttachments() [2/2]

void Aws::ECS::Model::ContainerInstance::SetAttachments ( Aws::Vector< Attachment > &&  value)
inline

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

Definition at line 936 of file ContainerInstance.h.

◆ SetAttributes() [1/2]

void Aws::ECS::Model::ContainerInstance::SetAttributes ( const Aws::Vector< Attribute > &  value)
inline

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

Definition at line 845 of file ContainerInstance.h.

◆ SetAttributes() [2/2]

void Aws::ECS::Model::ContainerInstance::SetAttributes ( Aws::Vector< Attribute > &&  value)
inline

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

Definition at line 852 of file ContainerInstance.h.

◆ SetCapacityProviderName() [1/3]

void Aws::ECS::Model::ContainerInstance::SetCapacityProviderName ( const Aws::String value)
inline

The capacity provider associated with the container instance.

Definition at line 184 of file ContainerInstance.h.

◆ SetCapacityProviderName() [2/3]

void Aws::ECS::Model::ContainerInstance::SetCapacityProviderName ( Aws::String &&  value)
inline

The capacity provider associated with the container instance.

Definition at line 189 of file ContainerInstance.h.

◆ SetCapacityProviderName() [3/3]

void Aws::ECS::Model::ContainerInstance::SetCapacityProviderName ( const char *  value)
inline

The capacity provider associated with the container instance.

Definition at line 194 of file ContainerInstance.h.

◆ SetContainerInstanceArn() [1/3]

void Aws::ECS::Model::ContainerInstance::SetContainerInstanceArn ( const Aws::String value)
inline

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.

Definition at line 77 of file ContainerInstance.h.

◆ SetContainerInstanceArn() [2/3]

void Aws::ECS::Model::ContainerInstance::SetContainerInstanceArn ( Aws::String &&  value)
inline

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.

Definition at line 87 of file ContainerInstance.h.

◆ SetContainerInstanceArn() [3/3]

void Aws::ECS::Model::ContainerInstance::SetContainerInstanceArn ( const char *  value)
inline

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.

Definition at line 97 of file ContainerInstance.h.

◆ SetEc2InstanceId() [1/3]

void Aws::ECS::Model::ContainerInstance::SetEc2InstanceId ( const Aws::String value)
inline

The EC2 instance ID of the container instance.

Definition at line 143 of file ContainerInstance.h.

◆ SetEc2InstanceId() [2/3]

void Aws::ECS::Model::ContainerInstance::SetEc2InstanceId ( Aws::String &&  value)
inline

The EC2 instance ID of the container instance.

Definition at line 148 of file ContainerInstance.h.

◆ SetEc2InstanceId() [3/3]

void Aws::ECS::Model::ContainerInstance::SetEc2InstanceId ( const char *  value)
inline

The EC2 instance ID of the container instance.

Definition at line 153 of file ContainerInstance.h.

◆ SetPendingTasksCount()

void Aws::ECS::Model::ContainerInstance::SetPendingTasksCount ( int  value)
inline

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

Definition at line 780 of file ContainerInstance.h.

◆ SetRegisteredAt() [1/2]

void Aws::ECS::Model::ContainerInstance::SetRegisteredAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the container instance was registered.

Definition at line 896 of file ContainerInstance.h.

◆ SetRegisteredAt() [2/2]

void Aws::ECS::Model::ContainerInstance::SetRegisteredAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the container instance was registered.

Definition at line 901 of file ContainerInstance.h.

◆ SetRegisteredResources() [1/2]

void Aws::ECS::Model::ContainerInstance::SetRegisteredResources ( const Aws::Vector< Resource > &  value)
inline

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.

Definition at line 414 of file ContainerInstance.h.

◆ SetRegisteredResources() [2/2]

void Aws::ECS::Model::ContainerInstance::SetRegisteredResources ( Aws::Vector< Resource > &&  value)
inline

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.

Definition at line 425 of file ContainerInstance.h.

◆ SetRemainingResources() [1/2]

void Aws::ECS::Model::ContainerInstance::SetRemainingResources ( const Aws::Vector< Resource > &  value)
inline

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.

Definition at line 325 of file ContainerInstance.h.

◆ SetRemainingResources() [2/2]

void Aws::ECS::Model::ContainerInstance::SetRemainingResources ( Aws::Vector< Resource > &&  value)
inline

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.

Definition at line 336 of file ContainerInstance.h.

◆ SetRunningTasksCount()

void Aws::ECS::Model::ContainerInstance::SetRunningTasksCount ( int  value)
inline

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

Definition at line 755 of file ContainerInstance.h.

◆ SetStatus() [1/3]

void Aws::ECS::Model::ContainerInstance::SetStatus ( const Aws::String value)
inline

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

Definition at line 542 of file ContainerInstance.h.

◆ SetStatus() [2/3]

void Aws::ECS::Model::ContainerInstance::SetStatus ( Aws::String &&  value)
inline

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

Definition at line 566 of file ContainerInstance.h.

◆ SetStatus() [3/3]

void Aws::ECS::Model::ContainerInstance::SetStatus ( const char *  value)
inline

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

Definition at line 590 of file ContainerInstance.h.

◆ SetStatusReason() [1/3]

void Aws::ECS::Model::ContainerInstance::SetStatusReason ( const Aws::String value)
inline

The reason that the container instance reached its current status.

Definition at line 678 of file ContainerInstance.h.

◆ SetStatusReason() [2/3]

void Aws::ECS::Model::ContainerInstance::SetStatusReason ( Aws::String &&  value)
inline

The reason that the container instance reached its current status.

Definition at line 683 of file ContainerInstance.h.

◆ SetStatusReason() [3/3]

void Aws::ECS::Model::ContainerInstance::SetStatusReason ( const char *  value)
inline

The reason that the container instance reached its current status.

Definition at line 688 of file ContainerInstance.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::ContainerInstance::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

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

Definition at line 1021 of file ContainerInstance.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::ContainerInstance::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

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

Definition at line 1041 of file ContainerInstance.h.

◆ SetVersion()

void Aws::ECS::Model::ContainerInstance::SetVersion ( long long  value)
inline

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.

Definition at line 243 of file ContainerInstance.h.

◆ SetVersionInfo() [1/2]

void Aws::ECS::Model::ContainerInstance::SetVersionInfo ( const VersionInfo value)
inline

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

Definition at line 273 of file ContainerInstance.h.

◆ SetVersionInfo() [2/2]

void Aws::ECS::Model::ContainerInstance::SetVersionInfo ( VersionInfo &&  value)
inline

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

Definition at line 279 of file ContainerInstance.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::StatusHasBeenSet ( ) const
inline

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

Definition at line 518 of file ContainerInstance.h.

◆ StatusReasonHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::StatusReasonHasBeenSet ( ) const
inline

The reason that the container instance reached its current status.

Definition at line 673 of file ContainerInstance.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::TagsHasBeenSet ( ) const
inline

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.

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

Definition at line 1001 of file ContainerInstance.h.

◆ VersionHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::VersionHasBeenSet ( ) const
inline

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.

Definition at line 232 of file ContainerInstance.h.

◆ VersionInfoHasBeenSet()

bool Aws::ECS::Model::ContainerInstance::VersionInfoHasBeenSet ( ) const
inline

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

Definition at line 267 of file ContainerInstance.h.

◆ WithAgentConnected()

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAgentConnected ( bool  value)
inline

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.

Definition at line 736 of file ContainerInstance.h.

◆ WithAgentUpdateStatus() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAgentUpdateStatus ( const AgentUpdateStatus value)
inline

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

Definition at line 817 of file ContainerInstance.h.

◆ WithAgentUpdateStatus() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAgentUpdateStatus ( AgentUpdateStatus &&  value)
inline

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

Definition at line 823 of file ContainerInstance.h.

◆ WithAttachments() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAttachments ( const Aws::Vector< Attachment > &  value)
inline

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

Definition at line 942 of file ContainerInstance.h.

◆ WithAttachments() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAttachments ( Aws::Vector< Attachment > &&  value)
inline

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

Definition at line 948 of file ContainerInstance.h.

◆ WithAttributes() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAttributes ( const Aws::Vector< Attribute > &  value)
inline

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

Definition at line 859 of file ContainerInstance.h.

◆ WithAttributes() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithAttributes ( Aws::Vector< Attribute > &&  value)
inline

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

Definition at line 866 of file ContainerInstance.h.

◆ WithCapacityProviderName() [1/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithCapacityProviderName ( const Aws::String value)
inline

The capacity provider associated with the container instance.

Definition at line 199 of file ContainerInstance.h.

◆ WithCapacityProviderName() [2/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithCapacityProviderName ( Aws::String &&  value)
inline

The capacity provider associated with the container instance.

Definition at line 204 of file ContainerInstance.h.

◆ WithCapacityProviderName() [3/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithCapacityProviderName ( const char *  value)
inline

The capacity provider associated with the container instance.

Definition at line 209 of file ContainerInstance.h.

◆ WithContainerInstanceArn() [1/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithContainerInstanceArn ( const Aws::String value)
inline

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.

Definition at line 107 of file ContainerInstance.h.

◆ WithContainerInstanceArn() [2/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithContainerInstanceArn ( Aws::String &&  value)
inline

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.

Definition at line 117 of file ContainerInstance.h.

◆ WithContainerInstanceArn() [3/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithContainerInstanceArn ( const char *  value)
inline

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.

Definition at line 127 of file ContainerInstance.h.

◆ WithEc2InstanceId() [1/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithEc2InstanceId ( const Aws::String value)
inline

The EC2 instance ID of the container instance.

Definition at line 158 of file ContainerInstance.h.

◆ WithEc2InstanceId() [2/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithEc2InstanceId ( Aws::String &&  value)
inline

The EC2 instance ID of the container instance.

Definition at line 163 of file ContainerInstance.h.

◆ WithEc2InstanceId() [3/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithEc2InstanceId ( const char *  value)
inline

The EC2 instance ID of the container instance.

Definition at line 168 of file ContainerInstance.h.

◆ WithPendingTasksCount()

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithPendingTasksCount ( int  value)
inline

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

Definition at line 786 of file ContainerInstance.h.

◆ WithRegisteredAt() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRegisteredAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the container instance was registered.

Definition at line 906 of file ContainerInstance.h.

◆ WithRegisteredAt() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRegisteredAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the container instance was registered.

Definition at line 911 of file ContainerInstance.h.

◆ WithRegisteredResources() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRegisteredResources ( const Aws::Vector< Resource > &  value)
inline

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.

Definition at line 436 of file ContainerInstance.h.

◆ WithRegisteredResources() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRegisteredResources ( Aws::Vector< Resource > &&  value)
inline

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.

Definition at line 447 of file ContainerInstance.h.

◆ WithRemainingResources() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRemainingResources ( const Aws::Vector< Resource > &  value)
inline

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.

Definition at line 347 of file ContainerInstance.h.

◆ WithRemainingResources() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRemainingResources ( Aws::Vector< Resource > &&  value)
inline

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.

Definition at line 358 of file ContainerInstance.h.

◆ WithRunningTasksCount()

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithRunningTasksCount ( int  value)
inline

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

Definition at line 761 of file ContainerInstance.h.

◆ WithStatus() [1/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatus ( const Aws::String value)
inline

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

Definition at line 614 of file ContainerInstance.h.

◆ WithStatus() [2/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatus ( Aws::String &&  value)
inline

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

Definition at line 638 of file ContainerInstance.h.

◆ WithStatus() [3/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatus ( const char *  value)
inline

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

Definition at line 662 of file ContainerInstance.h.

◆ WithStatusReason() [1/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatusReason ( const Aws::String value)
inline

The reason that the container instance reached its current status.

Definition at line 693 of file ContainerInstance.h.

◆ WithStatusReason() [2/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatusReason ( Aws::String &&  value)
inline

The reason that the container instance reached its current status.

Definition at line 698 of file ContainerInstance.h.

◆ WithStatusReason() [3/3]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithStatusReason ( const char *  value)
inline

The reason that the container instance reached its current status.

Definition at line 703 of file ContainerInstance.h.

◆ WithTags() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

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

Definition at line 1061 of file ContainerInstance.h.

◆ WithTags() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

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

Definition at line 1081 of file ContainerInstance.h.

◆ WithVersion()

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithVersion ( long long  value)
inline

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.

Definition at line 254 of file ContainerInstance.h.

◆ WithVersionInfo() [1/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithVersionInfo ( const VersionInfo value)
inline

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

Definition at line 285 of file ContainerInstance.h.

◆ WithVersionInfo() [2/2]

ContainerInstance& Aws::ECS::Model::ContainerInstance::WithVersionInfo ( VersionInfo &&  value)
inline

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

Definition at line 291 of file ContainerInstance.h.


The documentation for this class was generated from the following file: