CfnOptionGroupProps

class aws_cdk.aws_rds.CfnOptionGroupProps(*, engine_name, major_engine_version, option_group_description, option_configurations=None, tags=None)

Bases: object

Properties for defining a CfnOptionGroup.

Parameters
  • engine_name (str) – Specifies the name of the engine that this option group should be associated with. Valid Values: - mariadb - mysql - oracle-ee - oracle-se2 - oracle-se1 - oracle-se - postgres - sqlserver-ee - sqlserver-se - sqlserver-ex - sqlserver-web

  • major_engine_version (str) – Specifies the major version of the engine that this option group should be associated with.

  • option_group_description (str) – The description of the option group.

  • option_configurations (Union[IResolvable, Sequence[Union[IResolvable, OptionConfigurationProperty, Dict[str, Any]]], None]) – A list of options and the settings for each option.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the option group.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_option_group_props = rds.CfnOptionGroupProps(
    engine_name="engineName",
    major_engine_version="majorEngineVersion",
    option_group_description="optionGroupDescription",

    # the properties below are optional
    option_configurations=[rds.CfnOptionGroup.OptionConfigurationProperty(
        option_name="optionName",

        # the properties below are optional
        db_security_group_memberships=["dbSecurityGroupMemberships"],
        option_settings=[rds.CfnOptionGroup.OptionSettingProperty(
            name="name",
            value="value"
        )],
        option_version="optionVersion",
        port=123,
        vpc_security_group_memberships=["vpcSecurityGroupMemberships"]
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

engine_name

Specifies the name of the engine that this option group should be associated with.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename

Return type

str

major_engine_version

Specifies the major version of the engine that this option group should be associated with.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion

Return type

str

option_configurations

A list of options and the settings for each option.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, OptionConfigurationProperty]], None]

option_group_description

The description of the option group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription

Return type

str

tags

Tags to assign to the option group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags

Return type

Optional[List[CfnTag]]