AmazonElasticBeanstalkClient.ValidateConfigurationSettings Method (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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ValidateConfigurationSettingsAsync.

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

Syntax

public virtual ValidateConfigurationSettingsResponse ValidateConfigurationSettings(
         ValidateConfigurationSettingsRequest request
)

Parameters

request: Type: Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest

Container for the necessary parameters to execute the ValidateConfigurationSettings service method.

Return Value

Type: ValidateConfigurationSettingsResponse

The response from the ValidateConfigurationSettings service method, as returned by ElasticBeanstalk.

Exceptions

Exception	Condition
InsufficientPrivilegesException	The specified account does not have sufficient privileges for one or more AWS services.
TooManyBucketsException	The specified account has reached its limit of Amazon S3 buckets.

Examples

The following operation validates a CloudWatch custom metrics config document:

To validate configuration settings


var client = new AmazonElasticBeanstalkClient();
var response = client.ValidateConfigurationSettings(new ValidateConfigurationSettingsRequest 
{
    ApplicationName = "my-app",
    EnvironmentName = "my-env",
    OptionSettings = new List<ConfigurationOptionSetting> {
        new ConfigurationOptionSetting {
            Namespace = "aws:elasticbeanstalk:healthreporting:system",
            OptionName = "ConfigDocument",
            Value = "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}"
        }
    }
});

List<ValidationMessage> messages = response.Messages;

Version Information

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

AmazonElasticBeanstalkClient.ValidateConfigurationSettings (ValidateConfigurationSettingsRequest)

Method