Package software.amazon.awscdk.services.elasticbeanstalk

Interface CfnEnvironment.OptionSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironment.OptionSettingProperty.Jsii$Proxy

Enclosing class:

CfnEnvironment

@Stability(Stable)
public static interface CfnEnvironment.OptionSettingProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.elasticbeanstalk.*;
 OptionSettingProperty optionSettingProperty = OptionSettingProperty.builder()
         .namespace("namespace")
         .optionName("optionName")
         // the properties below are optional
         .resourceName("resourceName")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironment.OptionSettingProperty.Builder	A builder for CfnEnvironment.OptionSettingProperty
static final class	CfnEnvironment.OptionSettingProperty.Jsii$Proxy	An implementation for CfnEnvironment.OptionSettingProperty

Method Summary

Modifier and Type	Method	Description
static CfnEnvironment.OptionSettingProperty.Builder	builder()
String	getNamespace()	A unique namespace that identifies the option's associated AWS resource.
String	getOptionName()	The name of the configuration option.
default String	getResourceName()	A unique resource name for the option setting.
default String	getValue()	The current value for the configuration option.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-namespace

getOptionName

@Stability(Stable)
@NotNull
String getOptionName()

The name of the configuration option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-optionname

getResourceName

@Stability(Stable)
@Nullable
default String getResourceName()

A unique resource name for the option setting.

Use it for a time–based scaling configuration option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename

getValue

@Stability(Stable)
@Nullable
default String getValue()

The current value for the configuration option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-environment-optionsetting.html#cfn-elasticbeanstalk-environment-optionsetting-value

builder

@Stability(Stable)
static CfnEnvironment.OptionSettingProperty.Builder builder()

Returns:

a CfnEnvironment.OptionSettingProperty.Builder of CfnEnvironment.OptionSettingProperty