public static interface TerminateEnvironmentRequest.Builder extends ElasticBeanstalkRequest.Builder, CopyableBuilder<TerminateEnvironmentRequest.Builder,TerminateEnvironmentRequest>
Modifier and Type | Method and Description |
---|---|
TerminateEnvironmentRequest.Builder |
environmentId(String environmentId)
The ID of the environment to terminate.
|
TerminateEnvironmentRequest.Builder |
environmentName(String environmentName)
The name of the environment to terminate.
|
TerminateEnvironmentRequest.Builder |
forceTerminate(Boolean forceTerminate)
Terminates the target environment even if another environment in the same group is dependent on it.
|
TerminateEnvironmentRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
TerminateEnvironmentRequest.Builder |
terminateResources(Boolean terminateResources)
Indicates whether the associated AWS resources should shut down when the environment is terminated:
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
TerminateEnvironmentRequest.Builder environmentId(String environmentId)
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.
environmentId
- 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.
TerminateEnvironmentRequest.Builder environmentName(String environmentName)
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.
environmentName
- 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.
TerminateEnvironmentRequest.Builder terminateResources(Boolean terminateResources)
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
terminateResources
- 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
TerminateEnvironmentRequest.Builder forceTerminate(Boolean forceTerminate)
Terminates the target environment even if another environment in the same group is dependent on it.
forceTerminate
- Terminates the target environment even if another environment in the same group is dependent on it.TerminateEnvironmentRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.