Container for the parameters to the DescribeConfigurationSettings operation. 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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest
Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z
Syntax
public class DescribeConfigurationSettingsRequest : AmazonElasticBeanstalkRequest IAmazonWebServiceRequest
The DescribeConfigurationSettingsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeConfigurationSettingsRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
DescribeConfigurationSettingsRequest(string) |
Instantiates DescribeConfigurationSettingsRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ApplicationName | System.String |
Gets and sets the property ApplicationName. The application for the environment or configuration template. |
|
|
EnvironmentName | System.String |
Gets and sets the property EnvironmentName. The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify
both, AWS Elastic Beanstalk returns an |
|
|
TemplateName | System.String |
Gets and sets the property TemplateName. The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not
both. If you specify both, AWS Elastic Beanstalk returns an |
Examples
The following operation retrieves configuration settings for an environment named my-env:
To view configurations settings for an environment
var client = new AmazonElasticBeanstalkClient();
var response = client.DescribeConfigurationSettings(new DescribeConfigurationSettingsRequest
{
ApplicationName = "my-app",
EnvironmentName = "my-env"
});
List<ConfigurationSettingsDescription> configurationSettings = response.ConfigurationSettings;
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5