AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the TerminateEnvironment operation. Terminates the specified environment.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z

Syntax

C#
public class TerminateEnvironmentRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The TerminateEnvironmentRequest type exposes the following members

Constructors

NameDescription
Public Method TerminateEnvironmentRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property EnvironmentId System.String

Gets and sets the property 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.

Public Property EnvironmentName System.String

Gets and sets the property 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.

Public Property ForceTerminate System.Boolean

Gets and sets the property ForceTerminate.

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

Public Property TerminateResources System.Boolean

Gets and sets the property 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

Examples

The following operation terminates an Elastic Beanstalk environment named my-env:

To terminate an environment


var response = client.TerminateEnvironment(new TerminateEnvironmentRequest 
{
    EnvironmentName = "my-env"
});

bool abortableOperationInProgress = response.AbortableOperationInProgress;
string applicationName = response.ApplicationName;
string cname = response.CNAME;
DateTime dateCreated = response.DateCreated;
DateTime dateUpdated = response.DateUpdated;
string endpointURL = response.EndpointURL;
string environmentId = response.EnvironmentId;
string environmentName = response.EnvironmentName;
string health = response.Health;
string solutionStackName = response.SolutionStackName;
string status = response.Status;
EnvironmentTier tier = response.Tier;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms