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

#include <UpdateEnvironmentRequest.h>

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

Public Member Functions

 UpdateEnvironmentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApplicationName () const
 
bool ApplicationNameHasBeenSet () const
 
void SetApplicationName (const Aws::String &value)
 
void SetApplicationName (Aws::String &&value)
 
void SetApplicationName (const char *value)
 
UpdateEnvironmentRequestWithApplicationName (const Aws::String &value)
 
UpdateEnvironmentRequestWithApplicationName (Aws::String &&value)
 
UpdateEnvironmentRequestWithApplicationName (const char *value)
 
const Aws::StringGetEnvironmentId () const
 
bool EnvironmentIdHasBeenSet () const
 
void SetEnvironmentId (const Aws::String &value)
 
void SetEnvironmentId (Aws::String &&value)
 
void SetEnvironmentId (const char *value)
 
UpdateEnvironmentRequestWithEnvironmentId (const Aws::String &value)
 
UpdateEnvironmentRequestWithEnvironmentId (Aws::String &&value)
 
UpdateEnvironmentRequestWithEnvironmentId (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)
 
UpdateEnvironmentRequestWithEnvironmentName (const Aws::String &value)
 
UpdateEnvironmentRequestWithEnvironmentName (Aws::String &&value)
 
UpdateEnvironmentRequestWithEnvironmentName (const char *value)
 
const Aws::StringGetGroupName () const
 
bool GroupNameHasBeenSet () const
 
void SetGroupName (const Aws::String &value)
 
void SetGroupName (Aws::String &&value)
 
void SetGroupName (const char *value)
 
UpdateEnvironmentRequestWithGroupName (const Aws::String &value)
 
UpdateEnvironmentRequestWithGroupName (Aws::String &&value)
 
UpdateEnvironmentRequestWithGroupName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateEnvironmentRequestWithDescription (const Aws::String &value)
 
UpdateEnvironmentRequestWithDescription (Aws::String &&value)
 
UpdateEnvironmentRequestWithDescription (const char *value)
 
const EnvironmentTierGetTier () const
 
bool TierHasBeenSet () const
 
void SetTier (const EnvironmentTier &value)
 
void SetTier (EnvironmentTier &&value)
 
UpdateEnvironmentRequestWithTier (const EnvironmentTier &value)
 
UpdateEnvironmentRequestWithTier (EnvironmentTier &&value)
 
const Aws::StringGetVersionLabel () const
 
bool VersionLabelHasBeenSet () const
 
void SetVersionLabel (const Aws::String &value)
 
void SetVersionLabel (Aws::String &&value)
 
void SetVersionLabel (const char *value)
 
UpdateEnvironmentRequestWithVersionLabel (const Aws::String &value)
 
UpdateEnvironmentRequestWithVersionLabel (Aws::String &&value)
 
UpdateEnvironmentRequestWithVersionLabel (const char *value)
 
const Aws::StringGetTemplateName () const
 
bool TemplateNameHasBeenSet () const
 
void SetTemplateName (const Aws::String &value)
 
void SetTemplateName (Aws::String &&value)
 
void SetTemplateName (const char *value)
 
UpdateEnvironmentRequestWithTemplateName (const Aws::String &value)
 
UpdateEnvironmentRequestWithTemplateName (Aws::String &&value)
 
UpdateEnvironmentRequestWithTemplateName (const char *value)
 
const Aws::StringGetSolutionStackName () const
 
bool SolutionStackNameHasBeenSet () const
 
void SetSolutionStackName (const Aws::String &value)
 
void SetSolutionStackName (Aws::String &&value)
 
void SetSolutionStackName (const char *value)
 
UpdateEnvironmentRequestWithSolutionStackName (const Aws::String &value)
 
UpdateEnvironmentRequestWithSolutionStackName (Aws::String &&value)
 
UpdateEnvironmentRequestWithSolutionStackName (const char *value)
 
const Aws::StringGetPlatformArn () const
 
bool PlatformArnHasBeenSet () const
 
void SetPlatformArn (const Aws::String &value)
 
void SetPlatformArn (Aws::String &&value)
 
void SetPlatformArn (const char *value)
 
UpdateEnvironmentRequestWithPlatformArn (const Aws::String &value)
 
UpdateEnvironmentRequestWithPlatformArn (Aws::String &&value)
 
UpdateEnvironmentRequestWithPlatformArn (const char *value)
 
const Aws::Vector< ConfigurationOptionSetting > & GetOptionSettings () const
 
bool OptionSettingsHasBeenSet () const
 
void SetOptionSettings (const Aws::Vector< ConfigurationOptionSetting > &value)
 
void SetOptionSettings (Aws::Vector< ConfigurationOptionSetting > &&value)
 
UpdateEnvironmentRequestWithOptionSettings (const Aws::Vector< ConfigurationOptionSetting > &value)
 
UpdateEnvironmentRequestWithOptionSettings (Aws::Vector< ConfigurationOptionSetting > &&value)
 
UpdateEnvironmentRequestAddOptionSettings (const ConfigurationOptionSetting &value)
 
UpdateEnvironmentRequestAddOptionSettings (ConfigurationOptionSetting &&value)
 
const Aws::Vector< OptionSpecification > & GetOptionsToRemove () const
 
bool OptionsToRemoveHasBeenSet () const
 
void SetOptionsToRemove (const Aws::Vector< OptionSpecification > &value)
 
void SetOptionsToRemove (Aws::Vector< OptionSpecification > &&value)
 
UpdateEnvironmentRequestWithOptionsToRemove (const Aws::Vector< OptionSpecification > &value)
 
UpdateEnvironmentRequestWithOptionsToRemove (Aws::Vector< OptionSpecification > &&value)
 
UpdateEnvironmentRequestAddOptionsToRemove (const OptionSpecification &value)
 
UpdateEnvironmentRequestAddOptionsToRemove (OptionSpecification &&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 update an environment.

See Also:

AWS API Reference

Definition at line 28 of file UpdateEnvironmentRequest.h.

Constructor & Destructor Documentation

◆ UpdateEnvironmentRequest()

Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::UpdateEnvironmentRequest ( )

Member Function Documentation

◆ AddOptionSettings() [1/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::AddOptionSettings ( const ConfigurationOptionSetting value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 657 of file UpdateEnvironmentRequest.h.

◆ AddOptionSettings() [2/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::AddOptionSettings ( ConfigurationOptionSetting &&  value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 664 of file UpdateEnvironmentRequest.h.

◆ AddOptionsToRemove() [1/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::AddOptionsToRemove ( const OptionSpecification value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 707 of file UpdateEnvironmentRequest.h.

◆ AddOptionsToRemove() [2/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::AddOptionsToRemove ( OptionSpecification &&  value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 713 of file UpdateEnvironmentRequest.h.

◆ ApplicationNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::ApplicationNameHasBeenSet ( ) const
inline

The name of the application with which the environment is associated.

Definition at line 54 of file UpdateEnvironmentRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::DescriptionHasBeenSet ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 316 of file UpdateEnvironmentRequest.h.

◆ DumpBodyToUrl()

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::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::UpdateEnvironmentRequest::EnvironmentIdHasBeenSet ( ) const
inline

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 103 of file UpdateEnvironmentRequest.h.

◆ EnvironmentNameHasBeenSet()

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 176 of file UpdateEnvironmentRequest.h.

◆ GetApplicationName()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetApplicationName ( ) const
inline

The name of the application with which the environment is associated.

Definition at line 49 of file UpdateEnvironmentRequest.h.

◆ GetDescription()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetDescription ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 310 of file UpdateEnvironmentRequest.h.

◆ GetEnvironmentId()

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 94 of file UpdateEnvironmentRequest.h.

◆ GetEnvironmentName()

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 167 of file UpdateEnvironmentRequest.h.

◆ GetGroupName()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetGroupName ( ) const
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 240 of file UpdateEnvironmentRequest.h.

◆ GetOptionSettings()

const Aws::Vector<ConfigurationOptionSetting>& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetOptionSettings ( ) const
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 615 of file UpdateEnvironmentRequest.h.

◆ GetOptionsToRemove()

const Aws::Vector<OptionSpecification>& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetOptionsToRemove ( ) const
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 671 of file UpdateEnvironmentRequest.h.

◆ GetPlatformArn()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetPlatformArn ( ) const
inline

The ARN of the platform, if used.

Definition at line 572 of file UpdateEnvironmentRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateEnvironmentRequest.h.

◆ GetSolutionStackName()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetSolutionStackName ( ) const
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 524 of file UpdateEnvironmentRequest.h.

◆ GetTemplateName()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetTemplateName ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 461 of file UpdateEnvironmentRequest.h.

◆ GetTier()

const EnvironmentTier& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetTier ( ) const
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 360 of file UpdateEnvironmentRequest.h.

◆ GetVersionLabel()

const Aws::String& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GetVersionLabel ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 403 of file UpdateEnvironmentRequest.h.

◆ GroupNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::GroupNameHasBeenSet ( ) const
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 249 of file UpdateEnvironmentRequest.h.

◆ OptionSettingsHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::OptionSettingsHasBeenSet ( ) const
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 622 of file UpdateEnvironmentRequest.h.

◆ OptionsToRemoveHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::OptionsToRemoveHasBeenSet ( ) const
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 677 of file UpdateEnvironmentRequest.h.

◆ PlatformArnHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::PlatformArnHasBeenSet ( ) const
inline

The ARN of the platform, if used.

Definition at line 577 of file UpdateEnvironmentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplicationName() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetApplicationName ( const Aws::String value)
inline

The name of the application with which the environment is associated.

Definition at line 59 of file UpdateEnvironmentRequest.h.

◆ SetApplicationName() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetApplicationName ( Aws::String &&  value)
inline

The name of the application with which the environment is associated.

Definition at line 64 of file UpdateEnvironmentRequest.h.

◆ SetApplicationName() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetApplicationName ( const char *  value)
inline

The name of the application with which the environment is associated.

Definition at line 69 of file UpdateEnvironmentRequest.h.

◆ SetDescription() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetDescription ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 322 of file UpdateEnvironmentRequest.h.

◆ SetDescription() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetDescription ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 328 of file UpdateEnvironmentRequest.h.

◆ SetDescription() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetDescription ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 334 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentId() [1/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 112 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentId() [2/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 121 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentId() [3/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 130 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentName() [1/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 185 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentName() [2/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 194 of file UpdateEnvironmentRequest.h.

◆ SetEnvironmentName() [3/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 203 of file UpdateEnvironmentRequest.h.

◆ SetGroupName() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetGroupName ( const Aws::String value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 258 of file UpdateEnvironmentRequest.h.

◆ SetGroupName() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetGroupName ( Aws::String &&  value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 267 of file UpdateEnvironmentRequest.h.

◆ SetGroupName() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetGroupName ( const char *  value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 276 of file UpdateEnvironmentRequest.h.

◆ SetOptionSettings() [1/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetOptionSettings ( const Aws::Vector< ConfigurationOptionSetting > &  value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 629 of file UpdateEnvironmentRequest.h.

◆ SetOptionSettings() [2/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetOptionSettings ( Aws::Vector< ConfigurationOptionSetting > &&  value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 636 of file UpdateEnvironmentRequest.h.

◆ SetOptionsToRemove() [1/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetOptionsToRemove ( const Aws::Vector< OptionSpecification > &  value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 683 of file UpdateEnvironmentRequest.h.

◆ SetOptionsToRemove() [2/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetOptionsToRemove ( Aws::Vector< OptionSpecification > &&  value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 689 of file UpdateEnvironmentRequest.h.

◆ SetPlatformArn() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetPlatformArn ( const Aws::String value)
inline

The ARN of the platform, if used.

Definition at line 582 of file UpdateEnvironmentRequest.h.

◆ SetPlatformArn() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetPlatformArn ( Aws::String &&  value)
inline

The ARN of the platform, if used.

Definition at line 587 of file UpdateEnvironmentRequest.h.

◆ SetPlatformArn() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetPlatformArn ( const char *  value)
inline

The ARN of the platform, if used.

Definition at line 592 of file UpdateEnvironmentRequest.h.

◆ SetSolutionStackName() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetSolutionStackName ( const Aws::String value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 536 of file UpdateEnvironmentRequest.h.

◆ SetSolutionStackName() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetSolutionStackName ( Aws::String &&  value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 542 of file UpdateEnvironmentRequest.h.

◆ SetSolutionStackName() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetSolutionStackName ( const char *  value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 548 of file UpdateEnvironmentRequest.h.

◆ SetTemplateName() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetTemplateName ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 477 of file UpdateEnvironmentRequest.h.

◆ SetTemplateName() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetTemplateName ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 485 of file UpdateEnvironmentRequest.h.

◆ SetTemplateName() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetTemplateName ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 493 of file UpdateEnvironmentRequest.h.

◆ SetTier() [1/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetTier ( const EnvironmentTier value)
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 374 of file UpdateEnvironmentRequest.h.

◆ SetTier() [2/2]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetTier ( EnvironmentTier &&  value)
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 381 of file UpdateEnvironmentRequest.h.

◆ SetVersionLabel() [1/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetVersionLabel ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 417 of file UpdateEnvironmentRequest.h.

◆ SetVersionLabel() [2/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetVersionLabel ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 424 of file UpdateEnvironmentRequest.h.

◆ SetVersionLabel() [3/3]

void Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SetVersionLabel ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 431 of file UpdateEnvironmentRequest.h.

◆ SolutionStackNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::SolutionStackNameHasBeenSet ( ) const
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 530 of file UpdateEnvironmentRequest.h.

◆ TemplateNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::TemplateNameHasBeenSet ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 469 of file UpdateEnvironmentRequest.h.

◆ TierHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::TierHasBeenSet ( ) const
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 367 of file UpdateEnvironmentRequest.h.

◆ VersionLabelHasBeenSet()

bool Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::VersionLabelHasBeenSet ( ) const
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 410 of file UpdateEnvironmentRequest.h.

◆ WithApplicationName() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithApplicationName ( const Aws::String value)
inline

The name of the application with which the environment is associated.

Definition at line 74 of file UpdateEnvironmentRequest.h.

◆ WithApplicationName() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithApplicationName ( Aws::String &&  value)
inline

The name of the application with which the environment is associated.

Definition at line 79 of file UpdateEnvironmentRequest.h.

◆ WithApplicationName() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithApplicationName ( const char *  value)
inline

The name of the application with which the environment is associated.

Definition at line 84 of file UpdateEnvironmentRequest.h.

◆ WithDescription() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithDescription ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 340 of file UpdateEnvironmentRequest.h.

◆ WithDescription() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithDescription ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 346 of file UpdateEnvironmentRequest.h.

◆ WithDescription() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithDescription ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

Definition at line 352 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentId() [1/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 139 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentId() [2/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 148 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentId() [3/3]

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

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 157 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentName() [1/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 212 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentName() [2/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 221 of file UpdateEnvironmentRequest.h.

◆ WithEnvironmentName() [3/3]

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

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 230 of file UpdateEnvironmentRequest.h.

◆ WithGroupName() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithGroupName ( const Aws::String value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 285 of file UpdateEnvironmentRequest.h.

◆ WithGroupName() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithGroupName ( Aws::String &&  value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 294 of file UpdateEnvironmentRequest.h.

◆ WithGroupName() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithGroupName ( const char *  value)
inline

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

Definition at line 303 of file UpdateEnvironmentRequest.h.

◆ WithOptionSettings() [1/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithOptionSettings ( const Aws::Vector< ConfigurationOptionSetting > &  value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 643 of file UpdateEnvironmentRequest.h.

◆ WithOptionSettings() [2/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithOptionSettings ( Aws::Vector< ConfigurationOptionSetting > &&  value)
inline

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

Definition at line 650 of file UpdateEnvironmentRequest.h.

◆ WithOptionsToRemove() [1/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithOptionsToRemove ( const Aws::Vector< OptionSpecification > &  value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 695 of file UpdateEnvironmentRequest.h.

◆ WithOptionsToRemove() [2/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithOptionsToRemove ( Aws::Vector< OptionSpecification > &&  value)
inline

A list of custom user-defined configuration options to remove from the configuration set for this environment.

Definition at line 701 of file UpdateEnvironmentRequest.h.

◆ WithPlatformArn() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithPlatformArn ( const Aws::String value)
inline

The ARN of the platform, if used.

Definition at line 597 of file UpdateEnvironmentRequest.h.

◆ WithPlatformArn() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithPlatformArn ( Aws::String &&  value)
inline

The ARN of the platform, if used.

Definition at line 602 of file UpdateEnvironmentRequest.h.

◆ WithPlatformArn() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithPlatformArn ( const char *  value)
inline

The ARN of the platform, if used.

Definition at line 607 of file UpdateEnvironmentRequest.h.

◆ WithSolutionStackName() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithSolutionStackName ( const Aws::String value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 554 of file UpdateEnvironmentRequest.h.

◆ WithSolutionStackName() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithSolutionStackName ( Aws::String &&  value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 560 of file UpdateEnvironmentRequest.h.

◆ WithSolutionStackName() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithSolutionStackName ( const char *  value)
inline

This specifies the platform version that the environment will run after the environment is updated.

Definition at line 566 of file UpdateEnvironmentRequest.h.

◆ WithTemplateName() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithTemplateName ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 501 of file UpdateEnvironmentRequest.h.

◆ WithTemplateName() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithTemplateName ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 509 of file UpdateEnvironmentRequest.h.

◆ WithTemplateName() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithTemplateName ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Definition at line 517 of file UpdateEnvironmentRequest.h.

◆ WithTier() [1/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithTier ( const EnvironmentTier value)
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 388 of file UpdateEnvironmentRequest.h.

◆ WithTier() [2/2]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithTier ( EnvironmentTier &&  value)
inline

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

Definition at line 395 of file UpdateEnvironmentRequest.h.

◆ WithVersionLabel() [1/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithVersionLabel ( const Aws::String value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 438 of file UpdateEnvironmentRequest.h.

◆ WithVersionLabel() [2/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithVersionLabel ( Aws::String &&  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 445 of file UpdateEnvironmentRequest.h.

◆ WithVersionLabel() [3/3]

UpdateEnvironmentRequest& Aws::ElasticBeanstalk::Model::UpdateEnvironmentRequest::WithVersionLabel ( const char *  value)
inline

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

Definition at line 452 of file UpdateEnvironmentRequest.h.


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