Skip to content
v2.277.0

ConfigurationOptionSettingProperty Struct ​

Use the ConfigurationOptionSetting property type to specify an option for an AWS Elastic Beanstalk configuration template when defining an AWS::ElasticBeanstalk::ConfigurationTemplate resource in an AWS CloudFormation template.

The ConfigurationOptionSetting property type specifies an option for an AWS Elastic Beanstalk configuration template.

The OptionSettings property of the AWS::ElasticBeanstalk::ConfigurationTemplate resource contains a list of ConfigurationOptionSetting property types.

For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticbeanstalk as elasticbeanstalk } from 'aws-cdk-lib';
const configurationOptionSettingProperty: elasticbeanstalk.CfnConfigurationTemplate.ConfigurationOptionSettingProperty = {
  namespace: 'namespace',
  optionName: 'optionName',

  // the properties below are optional
  resourceName: 'resourceName',
  value: 'value',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticbeanstalk as elasticbeanstalk

configuration_option_setting_property = elasticbeanstalk.CfnConfigurationTemplate.ConfigurationOptionSettingProperty(
    namespace="namespace",
    option_name="optionName",

    # the properties below are optional
    resource_name="resourceName",
    value="value"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticbeanstalk.*;

ConfigurationOptionSettingProperty configurationOptionSettingProperty = ConfigurationOptionSettingProperty.builder()
        .namespace("namespace")
        .optionName("optionName")

        // the properties below are optional
        .resourceName("resourceName")
        .value("value")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticBeanstalk;

var configurationOptionSettingProperty = new ConfigurationOptionSettingProperty {
    Namespace = "namespace",
    OptionName = "optionName",

    // the properties below are optional
    ResourceName = "resourceName",
    Value = "value"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

configurationOptionSettingProperty := &ConfigurationOptionSettingProperty{
	Namespace: jsii.String("namespace"),
	OptionName: jsii.String("optionName"),

	// the properties below are optional
	ResourceName: jsii.String("resourceName"),
	Value: jsii.String("value"),
}

Properties ​

namespacestringnamespacestrnamespaceStringNamespacestringNamespace*stringrequired#
A unique namespace that identifies the option's associated AWS resource.
optionNamestringoption_namestroptionNameStringOptionNamestringOptionName*stringrequired#
The name of the configuration option.
resourceNameoptionalstringresource_nameoptionalstrresourceNameoptionalStringResourceNameoptionalstringResourceNameoptional*string#
A unique resource name for the option setting.

Use it for a time–based scaling configuration option.

valueoptionalstringvalueoptionalstrvalueoptionalStringValueoptionalstringValueoptional*string#
The current value for the configuration option.