251 lines
12 KiB
C++
251 lines
12 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/elasticbeanstalk/ElasticBeanstalk_EXPORTS.h>
|
|
#include <aws/elasticbeanstalk/ElasticBeanstalkRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace ElasticBeanstalk
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Request to terminate an environment.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/TerminateEnvironmentMessage">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_ELASTICBEANSTALK_API TerminateEnvironmentRequest : public ElasticBeanstalkRequest
|
|
{
|
|
public:
|
|
TerminateEnvironmentRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "TerminateEnvironment"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline const Aws::String& GetEnvironmentId() const{ return m_environmentId; }
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline bool EnvironmentIdHasBeenSet() const { return m_environmentIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentId(const Aws::String& value) { m_environmentIdHasBeenSet = true; m_environmentId = value; }
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentId(Aws::String&& value) { m_environmentIdHasBeenSet = true; m_environmentId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentId(const char* value) { m_environmentIdHasBeenSet = true; m_environmentId.assign(value); }
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentId(const Aws::String& value) { SetEnvironmentId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentId(Aws::String&& value) { SetEnvironmentId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The ID of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentName, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentId(const char* value) { SetEnvironmentId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline const Aws::String& GetEnvironmentName() const{ return m_environmentName; }
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline bool EnvironmentNameHasBeenSet() const { return m_environmentNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentName(const Aws::String& value) { m_environmentNameHasBeenSet = true; m_environmentName = value; }
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentName(Aws::String&& value) { m_environmentNameHasBeenSet = true; m_environmentName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline void SetEnvironmentName(const char* value) { m_environmentNameHasBeenSet = true; m_environmentName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentName(const Aws::String& value) { SetEnvironmentName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentName(Aws::String&& value) { SetEnvironmentName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the environment to terminate.</p> <p> Condition: You must specify
|
|
* either this or an EnvironmentId, or both. If you do not specify either, AWS
|
|
* Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithEnvironmentName(const char* value) { SetEnvironmentName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Indicates whether the associated AWS resources should shut down when the
|
|
* environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified
|
|
* environment as well as the associated AWS resources, such as Auto Scaling group
|
|
* and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: AWS
|
|
* Elastic Beanstalk resource management is removed from the environment, but the
|
|
* AWS resources continue to operate.</p> </li> </ul> <p> For more information, see
|
|
* the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS
|
|
* Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p>
|
|
* Valid Values: <code>true</code> | <code>false</code> </p>
|
|
*/
|
|
inline bool GetTerminateResources() const{ return m_terminateResources; }
|
|
|
|
/**
|
|
* <p>Indicates whether the associated AWS resources should shut down when the
|
|
* environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified
|
|
* environment as well as the associated AWS resources, such as Auto Scaling group
|
|
* and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: AWS
|
|
* Elastic Beanstalk resource management is removed from the environment, but the
|
|
* AWS resources continue to operate.</p> </li> </ul> <p> For more information, see
|
|
* the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS
|
|
* Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p>
|
|
* Valid Values: <code>true</code> | <code>false</code> </p>
|
|
*/
|
|
inline bool TerminateResourcesHasBeenSet() const { return m_terminateResourcesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates whether the associated AWS resources should shut down when the
|
|
* environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified
|
|
* environment as well as the associated AWS resources, such as Auto Scaling group
|
|
* and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: AWS
|
|
* Elastic Beanstalk resource management is removed from the environment, but the
|
|
* AWS resources continue to operate.</p> </li> </ul> <p> For more information, see
|
|
* the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS
|
|
* Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p>
|
|
* Valid Values: <code>true</code> | <code>false</code> </p>
|
|
*/
|
|
inline void SetTerminateResources(bool value) { m_terminateResourcesHasBeenSet = true; m_terminateResources = value; }
|
|
|
|
/**
|
|
* <p>Indicates whether the associated AWS resources should shut down when the
|
|
* environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified
|
|
* environment as well as the associated AWS resources, such as Auto Scaling group
|
|
* and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: AWS
|
|
* Elastic Beanstalk resource management is removed from the environment, but the
|
|
* AWS resources continue to operate.</p> </li> </ul> <p> For more information, see
|
|
* the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS
|
|
* Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p>
|
|
* Valid Values: <code>true</code> | <code>false</code> </p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithTerminateResources(bool value) { SetTerminateResources(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Terminates the target environment even if another environment in the same
|
|
* group is dependent on it.</p>
|
|
*/
|
|
inline bool GetForceTerminate() const{ return m_forceTerminate; }
|
|
|
|
/**
|
|
* <p>Terminates the target environment even if another environment in the same
|
|
* group is dependent on it.</p>
|
|
*/
|
|
inline bool ForceTerminateHasBeenSet() const { return m_forceTerminateHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Terminates the target environment even if another environment in the same
|
|
* group is dependent on it.</p>
|
|
*/
|
|
inline void SetForceTerminate(bool value) { m_forceTerminateHasBeenSet = true; m_forceTerminate = value; }
|
|
|
|
/**
|
|
* <p>Terminates the target environment even if another environment in the same
|
|
* group is dependent on it.</p>
|
|
*/
|
|
inline TerminateEnvironmentRequest& WithForceTerminate(bool value) { SetForceTerminate(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_environmentId;
|
|
bool m_environmentIdHasBeenSet;
|
|
|
|
Aws::String m_environmentName;
|
|
bool m_environmentNameHasBeenSet;
|
|
|
|
bool m_terminateResources;
|
|
bool m_terminateResourcesHasBeenSet;
|
|
|
|
bool m_forceTerminate;
|
|
bool m_forceTerminateHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace ElasticBeanstalk
|
|
} // namespace Aws
|