interface OptionSettingProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.ElasticBeanstalk.CfnEnvironment.OptionSettingProperty
Java	software.amazon.awscdk.services.elasticbeanstalk.CfnEnvironment.OptionSettingProperty
Python	aws_cdk.aws_elasticbeanstalk.CfnEnvironment.OptionSettingProperty
TypeScript	@aws-cdk/aws-elasticbeanstalk » CfnEnvironment » OptionSettingProperty

Use the OptionSetting property type to specify an option for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The OptionSetting property type specifies an option for an AWS Elastic Beanstalk environment.

The OptionSettings property of the AWS::ElasticBeanstalk::Environment resource contains a list of OptionSetting property types.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elasticbeanstalk from '@aws-cdk/aws-elasticbeanstalk';
const optionSettingProperty: elasticbeanstalk.CfnEnvironment.OptionSettingProperty = {
  namespace: 'namespace',
  optionName: 'optionName',

  // the properties below are optional
  resourceName: 'resourceName',
  value: 'value',
};

Properties

Name	Type	Description
namespace	string	A unique namespace that identifies the option's associated AWS resource.
optionName	string	The name of the configuration option.
resourceName?	string	A unique resource name for the option setting.
value?	string	The current value for the configuration option.

---

namespace

Type: string

A unique namespace that identifies the option's associated AWS resource.

---

optionName

Type: string

The name of the configuration option.

---

resourceName?

Type: string (optional)

A unique resource name for the option setting.

Use it for a time–based scaling configuration option.

---

value?

Type: string (optional)

The current value for the configuration option.