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.

Implementation for accessing ElasticBeanstalk AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient

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

Syntax

C#
public class AmazonElasticBeanstalkClient : AmazonServiceClient
         IAmazonElasticBeanstalk, IAmazonService, IDisposable

The AmazonElasticBeanstalkClient type exposes the following members

Constructors

NameDescription
Public Method AmazonElasticBeanstalkClient()

Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticBeanstalkClient(RegionEndpoint)

Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticBeanstalkClient(AmazonElasticBeanstalkConfig)

Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonElasticBeanstalkClient(AWSCredentials)

Constructs AmazonElasticBeanstalkClient with AWS Credentials

Public Method AmazonElasticBeanstalkClient(AWSCredentials, RegionEndpoint)

Constructs AmazonElasticBeanstalkClient with AWS Credentials

Public Method AmazonElasticBeanstalkClient(AWSCredentials, AmazonElasticBeanstalkConfig)

Constructs AmazonElasticBeanstalkClient with AWS Credentials and an AmazonElasticBeanstalkClient Configuration object.

Public Method AmazonElasticBeanstalkClient(string, string)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticBeanstalkClient(string, string, RegionEndpoint)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticBeanstalkClient(string, string, AmazonElasticBeanstalkConfig)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object.

Public Method AmazonElasticBeanstalkClient(string, string, string)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticBeanstalkClient(string, string, string, RegionEndpoint)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonElasticBeanstalkClient(string, string, string, AmazonElasticBeanstalkConfig)

Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AbortEnvironmentUpdate(AbortEnvironmentUpdateRequest)

Cancels in-progress environment configuration update or application version deployment.

Public Method AbortEnvironmentUpdateAsync(AbortEnvironmentUpdateRequest, CancellationToken)

Initiates the asynchronous execution of the AbortEnvironmentUpdate operation.

Public Method ApplyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest)

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

Public Method ApplyEnvironmentManagedActionAsync(ApplyEnvironmentManagedActionRequest, CancellationToken)

Initiates the asynchronous execution of the ApplyEnvironmentManagedAction operation.

Public Method CheckDNSAvailability(CheckDNSAvailabilityRequest)

Checks if the specified CNAME is available.

Public Method CheckDNSAvailabilityAsync(CheckDNSAvailabilityRequest, CancellationToken)

Initiates the asynchronous execution of the CheckDNSAvailability operation.

Public Method ComposeEnvironments(ComposeEnvironmentsRequest)

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

Public Method ComposeEnvironmentsAsync(ComposeEnvironmentsRequest, CancellationToken)

Initiates the asynchronous execution of the ComposeEnvironments operation.

Public Method CreateApplication(CreateApplicationRequest)

Creates an application that has one configuration template named default and no application versions.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApplication operation.

Public Method CreateApplicationVersion(CreateApplicationVersionRequest)

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Public Method CreateApplicationVersionAsync(CreateApplicationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApplicationVersion operation.

Public Method CreateConfigurationTemplate(CreateConfigurationTemplateRequest)

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

Public Method CreateConfigurationTemplateAsync(CreateConfigurationTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConfigurationTemplate operation.

Public Method CreateEnvironment(CreateEnvironmentRequest)

Launches an environment for the specified application using the specified configuration.

Public Method CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateEnvironment operation.

Public Method CreatePlatformVersion(CreatePlatformVersionRequest)

Create a new version of your custom platform.

Public Method CreatePlatformVersionAsync(CreatePlatformVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePlatformVersion operation.

Public Method CreateStorageLocation()

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Public Method CreateStorageLocation(CreateStorageLocationRequest)

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Public Method CreateStorageLocationAsync(CancellationToken)

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Public Method CreateStorageLocationAsync(CreateStorageLocationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStorageLocation operation.

Public Method DeleteApplication(DeleteApplicationRequest)

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApplication operation.

Public Method DeleteApplicationVersion(DeleteApplicationVersionRequest)

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

Public Method DeleteApplicationVersionAsync(DeleteApplicationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApplicationVersion operation.

Public Method DeleteConfigurationTemplate(DeleteConfigurationTemplateRequest)

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

Public Method DeleteConfigurationTemplateAsync(DeleteConfigurationTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigurationTemplate operation.

Public Method DeleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest)

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Public Method DeleteEnvironmentConfigurationAsync(DeleteEnvironmentConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation.

Public Method DeletePlatformVersion(DeletePlatformVersionRequest)

Deletes the specified version of a custom platform.

Public Method DeletePlatformVersionAsync(DeletePlatformVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePlatformVersion operation.

Public Method DescribeApplications()

Returns the descriptions of existing applications.

Public Method DescribeApplications(DescribeApplicationsRequest)

Returns the descriptions of existing applications.

Public Method DescribeApplicationsAsync(CancellationToken)

Returns the descriptions of existing applications.

Public Method DescribeApplicationsAsync(DescribeApplicationsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeApplications operation.

Public Method DescribeApplicationVersions()

Retrieve a list of application versions.

Public Method DescribeApplicationVersions(DescribeApplicationVersionsRequest)

Retrieve a list of application versions.

Public Method DescribeApplicationVersionsAsync(CancellationToken)

Retrieve a list of application versions.

Public Method DescribeApplicationVersionsAsync(DescribeApplicationVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeApplicationVersions operation.

Public Method DescribeConfigurationOptions()

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Public Method DescribeConfigurationOptions(DescribeConfigurationOptionsRequest)

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Public Method DescribeConfigurationOptionsAsync(CancellationToken)

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Public Method DescribeConfigurationOptionsAsync(DescribeConfigurationOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationOptions operation.

Public Method DescribeConfigurationSettings(DescribeConfigurationSettingsRequest)

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

Public Method DescribeConfigurationSettingsAsync(DescribeConfigurationSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationSettings operation.

Public Method DescribeEnvironmentHealth(DescribeEnvironmentHealthRequest)

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Public Method DescribeEnvironmentHealthAsync(DescribeEnvironmentHealthRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEnvironmentHealth operation.

Public Method DescribeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest)

Lists an environment's completed and failed managed actions.

Public Method DescribeEnvironmentManagedActionHistoryAsync(DescribeEnvironmentManagedActionHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEnvironmentManagedActionHistory operation.

Public Method DescribeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest)

Lists an environment's upcoming and in-progress managed actions.

Public Method DescribeEnvironmentManagedActionsAsync(DescribeEnvironmentManagedActionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEnvironmentManagedActions operation.

Public Method DescribeEnvironmentResources(DescribeEnvironmentResourcesRequest)

Returns AWS resources for this environment.

Public Method DescribeEnvironmentResourcesAsync(DescribeEnvironmentResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEnvironmentResources operation.

Public Method DescribeEnvironments()

Returns descriptions for existing environments.

Public Method DescribeEnvironments(DescribeEnvironmentsRequest)

Returns descriptions for existing environments.

Public Method DescribeEnvironmentsAsync(CancellationToken)

Returns descriptions for existing environments.

Public Method DescribeEnvironmentsAsync(DescribeEnvironmentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEnvironments operation.

Public Method DescribeEvents()

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Public Method DescribeEvents(DescribeEventsRequest)

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Public Method DescribeEventsAsync(CancellationToken)

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEvents operation.

Public Method DescribeInstancesHealth(DescribeInstancesHealthRequest)

Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Public Method DescribeInstancesHealthAsync(DescribeInstancesHealthRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeInstancesHealth operation.

Public Method DescribePlatformVersion(DescribePlatformVersionRequest)

Describes the version of the platform.

Public Method DescribePlatformVersionAsync(DescribePlatformVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePlatformVersion operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListAvailableSolutionStacks()

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Public Method ListAvailableSolutionStacks(ListAvailableSolutionStacksRequest)

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Public Method ListAvailableSolutionStacksAsync(CancellationToken)

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Public Method ListAvailableSolutionStacksAsync(ListAvailableSolutionStacksRequest, CancellationToken)

Initiates the asynchronous execution of the ListAvailableSolutionStacks operation.

Public Method ListPlatformVersions(ListPlatformVersionsRequest)

Lists the available platforms.

Public Method ListPlatformVersionsAsync(ListPlatformVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPlatformVersions operation.

Public Method RebuildEnvironment(RebuildEnvironmentRequest)

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

Public Method RebuildEnvironmentAsync(RebuildEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the RebuildEnvironment operation.

Public Method RequestEnvironmentInfo(RequestEnvironmentInfoRequest)

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

Public Method RequestEnvironmentInfoAsync(RequestEnvironmentInfoRequest, CancellationToken)

Initiates the asynchronous execution of the RequestEnvironmentInfo operation.

Public Method RestartAppServer(RestartAppServerRequest)

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Public Method RestartAppServerAsync(RestartAppServerRequest, CancellationToken)

Initiates the asynchronous execution of the RestartAppServer operation.

Public Method RetrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest)

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Public Method RetrieveEnvironmentInfoAsync(RetrieveEnvironmentInfoRequest, CancellationToken)

Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation.

Public Method SwapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)

Swaps the CNAMEs of two environments.

Public Method SwapEnvironmentCNAMEsAsync(SwapEnvironmentCNAMEsRequest, CancellationToken)

Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation.

Public Method TerminateEnvironment(TerminateEnvironmentRequest)

Terminates the specified environment.

Public Method TerminateEnvironmentAsync(TerminateEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateEnvironment operation.

Public Method UpdateApplication(UpdateApplicationRequest)

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplication operation.

Public Method UpdateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest)

Modifies lifecycle settings for an application.

Public Method UpdateApplicationResourceLifecycleAsync(UpdateApplicationResourceLifecycleRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplicationResourceLifecycle operation.

Public Method UpdateApplicationVersion(UpdateApplicationVersionRequest)

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Public Method UpdateApplicationVersionAsync(UpdateApplicationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplicationVersion operation.

Public Method UpdateConfigurationTemplate(UpdateConfigurationTemplateRequest)

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

Public Method UpdateConfigurationTemplateAsync(UpdateConfigurationTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConfigurationTemplate operation.

Public Method UpdateEnvironment(UpdateEnvironmentRequest)

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

Public Method UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEnvironment operation.

Public Method ValidateConfigurationSettings(ValidateConfigurationSettingsRequest)

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

Public Method ValidateConfigurationSettingsAsync(ValidateConfigurationSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the ValidateConfigurationSettings operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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