CfnOptionGroupPropsMixin

class aws_cdk.mixins_preview.aws_rds.mixins.CfnOptionGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html
CloudformationResource:: AWS::RDS::OptionGroup
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_rds import mixins as rds_mixins

cfn_option_group_props_mixin = rds_mixins.CfnOptionGroupPropsMixin(rds_mixins.CfnOptionGroupMixinProps(
    engine_name="engineName",
    major_engine_version="majorEngineVersion",
    option_configurations=[rds_mixins.CfnOptionGroupPropsMixin.OptionConfigurationProperty(
        db_security_group_memberships=["dbSecurityGroupMemberships"],
        option_name="optionName",
        option_settings=[rds_mixins.CfnOptionGroupPropsMixin.OptionSettingProperty(
            name="name",
            value="value"
        )],
        option_version="optionVersion",
        port=123,
        vpc_security_group_memberships=["vpcSecurityGroupMemberships"]
    )],
    option_group_description="optionGroupDescription",
    option_group_name="optionGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RDS::OptionGroup.

Parameters:

props (Union[CfnOptionGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['engineName', 'majorEngineVersion', 'optionConfigurations', 'optionGroupDescription', 'optionGroupName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

OptionConfigurationProperty

class CfnOptionGroupPropsMixin.OptionConfigurationProperty(*, db_security_group_memberships=None, option_name=None, option_settings=None, option_version=None, port=None, vpc_security_group_memberships=None)

Bases: object

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

Parameters:

db_security_group_memberships (Optional[Sequence[str]]) – A list of DB security groups used for this option.
option_name (Optional[str]) – The configuration of options to include in a group.
option_settings (Union[IResolvable, Sequence[Union[IResolvable, OptionSettingProperty, Dict[str, Any]]], None]) – The option settings to include in an option group.
option_version (Optional[str]) – The version for the option.
port (Union[int, float, None]) – The optional port for the option.
vpc_security_group_memberships (Optional[Sequence[str]]) – A list of VPC security group names used for this option.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_rds import mixins as rds_mixins

option_configuration_property = rds_mixins.CfnOptionGroupPropsMixin.OptionConfigurationProperty(
    db_security_group_memberships=["dbSecurityGroupMemberships"],
    option_name="optionName",
    option_settings=[rds_mixins.CfnOptionGroupPropsMixin.OptionSettingProperty(
        name="name",
        value="value"
    )],
    option_version="optionVersion",
    port=123,
    vpc_security_group_memberships=["vpcSecurityGroupMemberships"]
)

Attributes

db_security_group_memberships

A list of DB security groups used for this option.

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

option_name

The configuration of options to include in a group.

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

option_settings

The option settings to include in an option group.

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

option_version

The version for the option.

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

port

The optional port for the option.

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

vpc_security_group_memberships

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

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

OptionSettingProperty

class CfnOptionGroupPropsMixin.OptionSettingProperty(*, name=None, value=None)

Bases: object

The OptionSetting property type specifies the value for an option within an OptionSetting property.

Parameters:

name (Optional[str]) – The name of the option that has settings that you can set.
value (Optional[str]) – The current value of the option setting.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_rds import mixins as rds_mixins

option_setting_property = rds_mixins.CfnOptionGroupPropsMixin.OptionSettingProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the option that has settings that you can set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-name

value

The current value of the option setting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-value