CfnOptionGroupProps
- class aws_cdk.aws_rds.CfnOptionGroupProps(*, engine_name, major_engine_version, option_group_description, option_configurations=None, option_group_name=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-ee-cdb
-oracle-se2
-oracle-se2-cdb
-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.option_group_name (
Optional
[str
]) – The name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Can’t end with a hyphen or contain two consecutive hyphens Example:myoptiongroup
If you don’t specify a value forOptionGroupName
property, a name is automatically created for the option group. .. epigraph:: This value is stored as a lowercase string.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An optional array of key-value pairs to apply to this 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"] )], option_group_name="optionGroupName", 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-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
- major_engine_version
Specifies the major version of the engine that this option group should be associated with.
- option_configurations
A list of options and the settings for each option.
- option_group_description
The description of the option group.
- option_group_name
The name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can’t end with a hyphen or contain two consecutive hyphens
Example:
myoptiongroup
If you don’t specify a value for
OptionGroupName
property, a name is automatically created for the option group. .. epigraph:This value is stored as a lowercase string.
- tags
An optional array of key-value pairs to apply to this option group.