CfnOptionGroup
- class aws_cdk.aws_rds.CfnOptionGroup(scope, id, *, engine_name, major_engine_version, option_group_description, option_configurations=None, option_group_name=None, tags=None)
Bases:
CfnResource
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
- 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 import aws_rds as rds cfn_option_group = rds.CfnOptionGroup(self, "MyCfnOptionGroup", 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" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).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 all available options for an option group.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
]]]]) – Tags to assign to the option group.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::RDS::OptionGroup'
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- engine_name
Specifies the name of the engine that this option group should be associated with.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- major_engine_version
Specifies the major version of the engine that this option group should be associated with.
- node
The tree node.
- option_configurations
A list of all available options for an option group.
- option_group_description
The description of the option group.
- option_group_name
The name of the option group to be created.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
Tags to assign to the option group.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
OptionConfigurationProperty
- class CfnOptionGroup.OptionConfigurationProperty(*, option_name, db_security_group_memberships=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 anAWS::RDS::OptionGroup
resource.- Parameters:
option_name (
str
) – The configuration of options to include in a group.db_security_group_memberships (
Optional
[Sequence
[str
]]) – A list of DB security groups used for this option.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:
- 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 import aws_rds as rds option_configuration_property = 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"] )
Attributes
- db_security_group_memberships
A list of DB security groups used for this option.
- option_name
The configuration of options to include in a group.
- option_settings
The option settings to include in an option group.
- option_version
The version for the option.
- port
The optional port for the option.
- vpc_security_group_memberships
A list of VPC security group names used for this option.
OptionSettingProperty
- class CfnOptionGroup.OptionSettingProperty(*, name=None, value=None)
Bases:
object
The
OptionSetting
property type specifies the value for an option within anOptionSetting
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:
- 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 import aws_rds as rds option_setting_property = rds.CfnOptionGroup.OptionSettingProperty( name="name", value="value" )
Attributes
- name
The name of the option that has settings that you can set.
- value
The current value of the option setting.