Package software.amazon.awscdk.services.rds

Interface CfnOptionGroup.OptionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOptionGroup.OptionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnOptionGroup

@Stability(Stable)
public static interface CfnOptionGroup.OptionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource.

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.rds.*;
 OptionConfigurationProperty optionConfigurationProperty = OptionConfigurationProperty.builder()
         .optionName("optionName")
         // the properties below are optional
         .dbSecurityGroupMemberships(List.of("dbSecurityGroupMemberships"))
         .optionSettings(List.of(OptionSettingProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .optionVersion("optionVersion")
         .port(123)
         .vpcSecurityGroupMemberships(List.of("vpcSecurityGroupMemberships"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOptionGroup.OptionConfigurationProperty.Builder	builder()
default List<String>	getDbSecurityGroupMemberships()	A list of DB security groups used for this option.
String	getOptionName()	The configuration of options to include in a group.
default Object	getOptionSettings()	The option settings to include in an option group.
default String	getOptionVersion()	The version for the option.
default Number	getPort()	The optional port for the option.
default List<String>	getVpcSecurityGroupMemberships()	A list of VPC security group names used for this option.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOptionName

@Stability(Stable)
@NotNull
String getOptionName()

The configuration of options to include in a group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionname

getDbSecurityGroupMemberships

@Stability(Stable)
@Nullable
default List<String> getDbSecurityGroupMemberships()

A list of DB security groups used for this option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-dbsecuritygroupmemberships

getOptionSettings

@Stability(Stable)
@Nullable
default Object getOptionSettings()

The option settings to include in an option group.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOptionGroup.OptionSettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionsettings

getOptionVersion

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

The version for the option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionversion

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The optional port for the option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-port

getVpcSecurityGroupMemberships

@Stability(Stable)
@Nullable
default List<String> getVpcSecurityGroupMemberships()

A list of VPC security group names used for this option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-vpcsecuritygroupmemberships

builder

@Stability(Stable)
static CfnOptionGroup.OptionConfigurationProperty.Builder builder()

Returns:

a CfnOptionGroup.OptionConfigurationProperty.Builder of CfnOptionGroup.OptionConfigurationProperty