ValidateConfigurationSettingsRequest Class

Container for the parameters to the ValidateConfigurationSettings operation. 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.

Inheritance Hierarchy

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

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

Syntax

public class ValidateConfigurationSettingsRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The ValidateConfigurationSettingsRequest type exposes the following members

Constructors

	Name	Description
	ValidateConfigurationSettingsRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	ValidateConfigurationSettingsRequest(string, List<ConfigurationOptionSetting>)	Instantiates ValidateConfigurationSettingsRequest with the parameterized properties

Properties

Name	Type	Description
ApplicationName	System.String	Gets and sets the property ApplicationName. The name of the application that the configuration template or environment belongs to.
EnvironmentName	System.String	Gets and sets the property EnvironmentName. The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name.
OptionSettings	System.Collections.Generic.List<Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting>	Gets and sets the property OptionSettings. A list of the options and desired values to evaluate.
TemplateName	System.String	Gets and sets the property TemplateName. The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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