AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest Class Reference

#include <TerminateEnvironmentRequest.h>

+ Inheritance diagram for Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest:

Public Member Functions

 TerminateEnvironmentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetEnvironmentId () const
 
bool EnvironmentIdHasBeenSet () const
 
void SetEnvironmentId (const Aws::String &value)
 
void SetEnvironmentId (Aws::String &&value)
 
void SetEnvironmentId (const char *value)
 
TerminateEnvironmentRequestWithEnvironmentId (const Aws::String &value)
 
TerminateEnvironmentRequestWithEnvironmentId (Aws::String &&value)
 
TerminateEnvironmentRequestWithEnvironmentId (const char *value)
 
const Aws::StringGetEnvironmentName () const
 
bool EnvironmentNameHasBeenSet () const
 
void SetEnvironmentName (const Aws::String &value)
 
void SetEnvironmentName (Aws::String &&value)
 
void SetEnvironmentName (const char *value)
 
TerminateEnvironmentRequestWithEnvironmentName (const Aws::String &value)
 
TerminateEnvironmentRequestWithEnvironmentName (Aws::String &&value)
 
TerminateEnvironmentRequestWithEnvironmentName (const char *value)
 
bool GetTerminateResources () const
 
bool TerminateResourcesHasBeenSet () const
 
void SetTerminateResources (bool value)
 
TerminateEnvironmentRequestWithTerminateResources (bool value)
 
bool GetForceTerminate () const
 
bool ForceTerminateHasBeenSet () const
 
void SetForceTerminate (bool value)
 
TerminateEnvironmentRequestWithForceTerminate (bool value)
 
- Public Member Functions inherited from Aws::ElasticBeanstalk::ElasticBeanstalkRequest
virtual ~ElasticBeanstalkRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::ElasticBeanstalk::ElasticBeanstalkRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Request to terminate an environment.

See Also:

AWS API Reference

Definition at line 24 of file TerminateEnvironmentRequest.h.

Constructor & Destructor Documentation

◆ TerminateEnvironmentRequest()

Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::TerminateEnvironmentRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnvironmentIdHasBeenSet()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::EnvironmentIdHasBeenSet ( ) const
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 54 of file TerminateEnvironmentRequest.h.

◆ EnvironmentNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::EnvironmentNameHasBeenSet ( ) const
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 111 of file TerminateEnvironmentRequest.h.

◆ ForceTerminateHasBeenSet()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::ForceTerminateHasBeenSet ( ) const
inline

Terminates the target environment even if another environment in the same group is dependent on it.

Definition at line 219 of file TerminateEnvironmentRequest.h.

◆ GetEnvironmentId()

const Aws::String& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::GetEnvironmentId ( ) const
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 47 of file TerminateEnvironmentRequest.h.

◆ GetEnvironmentName()

const Aws::String& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::GetEnvironmentName ( ) const
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 104 of file TerminateEnvironmentRequest.h.

◆ GetForceTerminate()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::GetForceTerminate ( ) const
inline

Terminates the target environment even if another environment in the same group is dependent on it.

Definition at line 213 of file TerminateEnvironmentRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file TerminateEnvironmentRequest.h.

◆ GetTerminateResources()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::GetTerminateResources ( ) const
inline

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

Definition at line 167 of file TerminateEnvironmentRequest.h.

◆ SerializePayload()

Aws::String Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEnvironmentId() [1/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentId ( const Aws::String value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 61 of file TerminateEnvironmentRequest.h.

◆ SetEnvironmentId() [2/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentId ( Aws::String &&  value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 68 of file TerminateEnvironmentRequest.h.

◆ SetEnvironmentId() [3/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentId ( const char *  value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 75 of file TerminateEnvironmentRequest.h.

◆ SetEnvironmentName() [1/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentName ( const Aws::String value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 118 of file TerminateEnvironmentRequest.h.

◆ SetEnvironmentName() [2/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentName ( Aws::String &&  value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 125 of file TerminateEnvironmentRequest.h.

◆ SetEnvironmentName() [3/3]

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetEnvironmentName ( const char *  value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 132 of file TerminateEnvironmentRequest.h.

◆ SetForceTerminate()

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetForceTerminate ( bool  value)
inline

Terminates the target environment even if another environment in the same group is dependent on it.

Definition at line 225 of file TerminateEnvironmentRequest.h.

◆ SetTerminateResources()

void Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::SetTerminateResources ( bool  value)
inline

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

Definition at line 193 of file TerminateEnvironmentRequest.h.

◆ TerminateResourcesHasBeenSet()

bool Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::TerminateResourcesHasBeenSet ( ) const
inline

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

Definition at line 180 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentId() [1/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentId ( const Aws::String value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 82 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentId() [2/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentId ( Aws::String &&  value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 89 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentId() [3/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentId ( const char *  value)
inline

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 96 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentName() [1/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentName ( const Aws::String value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 139 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentName() [2/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentName ( Aws::String &&  value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 146 of file TerminateEnvironmentRequest.h.

◆ WithEnvironmentName() [3/3]

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithEnvironmentName ( const char *  value)
inline

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Definition at line 153 of file TerminateEnvironmentRequest.h.

◆ WithForceTerminate()

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithForceTerminate ( bool  value)
inline

Terminates the target environment even if another environment in the same group is dependent on it.

Definition at line 231 of file TerminateEnvironmentRequest.h.

◆ WithTerminateResources()

TerminateEnvironmentRequest& Aws::ElasticBeanstalk::Model::TerminateEnvironmentRequest::WithTerminateResources ( bool  value)
inline

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

Definition at line 206 of file TerminateEnvironmentRequest.h.


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