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

#include <DeregisterContainerInstanceRequest.h>

+ Inheritance diagram for Aws::ECS::Model::DeregisterContainerInstanceRequest:

Public Member Functions

 DeregisterContainerInstanceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
DeregisterContainerInstanceRequestWithCluster (const Aws::String &value)
 
DeregisterContainerInstanceRequestWithCluster (Aws::String &&value)
 
DeregisterContainerInstanceRequestWithCluster (const char *value)
 
const Aws::StringGetContainerInstance () const
 
bool ContainerInstanceHasBeenSet () const
 
void SetContainerInstance (const Aws::String &value)
 
void SetContainerInstance (Aws::String &&value)
 
void SetContainerInstance (const char *value)
 
DeregisterContainerInstanceRequestWithContainerInstance (const Aws::String &value)
 
DeregisterContainerInstanceRequestWithContainerInstance (Aws::String &&value)
 
DeregisterContainerInstanceRequestWithContainerInstance (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
DeregisterContainerInstanceRequestWithForce (bool value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file DeregisterContainerInstanceRequest.h.

Constructor & Destructor Documentation

◆ DeregisterContainerInstanceRequest()

Aws::ECS::Model::DeregisterContainerInstanceRequest::DeregisterContainerInstanceRequest ( )

Member Function Documentation

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::DeregisterContainerInstanceRequest::ClusterHasBeenSet ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 49 of file DeregisterContainerInstanceRequest.h.

◆ ContainerInstanceHasBeenSet()

bool Aws::ECS::Model::DeregisterContainerInstanceRequest::ContainerInstanceHasBeenSet ( ) const
inline

The container instance ID or full ARN of the container instance to deregister. 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 112 of file DeregisterContainerInstanceRequest.h.

◆ ForceHasBeenSet()

bool Aws::ECS::Model::DeregisterContainerInstanceRequest::ForceHasBeenSet ( ) const
inline

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Definition at line 203 of file DeregisterContainerInstanceRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::DeregisterContainerInstanceRequest::GetCluster ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 42 of file DeregisterContainerInstanceRequest.h.

◆ GetContainerInstance()

const Aws::String& Aws::ECS::Model::DeregisterContainerInstanceRequest::GetContainerInstance ( ) const
inline

The container instance ID or full ARN of the container instance to deregister. 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 102 of file DeregisterContainerInstanceRequest.h.

◆ GetForce()

bool Aws::ECS::Model::DeregisterContainerInstanceRequest::GetForce ( ) const
inline

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Definition at line 188 of file DeregisterContainerInstanceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::DeregisterContainerInstanceRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::DeregisterContainerInstanceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeregisterContainerInstanceRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::DeregisterContainerInstanceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCluster() [1/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 56 of file DeregisterContainerInstanceRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 63 of file DeregisterContainerInstanceRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 70 of file DeregisterContainerInstanceRequest.h.

◆ SetContainerInstance() [1/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetContainerInstance ( const Aws::String value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 122 of file DeregisterContainerInstanceRequest.h.

◆ SetContainerInstance() [2/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetContainerInstance ( Aws::String &&  value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 132 of file DeregisterContainerInstanceRequest.h.

◆ SetContainerInstance() [3/3]

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetContainerInstance ( const char *  value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 142 of file DeregisterContainerInstanceRequest.h.

◆ SetForce()

void Aws::ECS::Model::DeregisterContainerInstanceRequest::SetForce ( bool  value)
inline

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Definition at line 218 of file DeregisterContainerInstanceRequest.h.

◆ WithCluster() [1/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 77 of file DeregisterContainerInstanceRequest.h.

◆ WithCluster() [2/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 84 of file DeregisterContainerInstanceRequest.h.

◆ WithCluster() [3/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

Definition at line 91 of file DeregisterContainerInstanceRequest.h.

◆ WithContainerInstance() [1/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithContainerInstance ( const Aws::String value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 152 of file DeregisterContainerInstanceRequest.h.

◆ WithContainerInstance() [2/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithContainerInstance ( Aws::String &&  value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 162 of file DeregisterContainerInstanceRequest.h.

◆ WithContainerInstance() [3/3]

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithContainerInstance ( const char *  value)
inline

The container instance ID or full ARN of the container instance to deregister. 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 172 of file DeregisterContainerInstanceRequest.h.

◆ WithForce()

DeregisterContainerInstanceRequest& Aws::ECS::Model::DeregisterContainerInstanceRequest::WithForce ( bool  value)
inline

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Definition at line 233 of file DeregisterContainerInstanceRequest.h.


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