IOptionGroup

class aws_cdk.aws_rds.IOptionGroup(*args, **kwargs)

Bases: IResource, Protocol

An option group.

Methods

add_configuration(*, name, port=None, security_groups=None, settings=None, version=None, vpc=None)

Adds a configuration to this OptionGroup.

This method is a no-op for an imported OptionGroup.

Parameters:

  • name (str) – The name of the option.

  • port (Union[int, float, None]) – The port number that this option uses. If port is specified then vpc must also be specified. Default: - no port

  • security_groups (Optional[Sequence[ISecurityGroup]]) – Optional list of security groups to use for this option, if vpc is specified. If no groups are provided, a default one will be created. Default: - a default group will be created if port or vpc are specified.

  • settings (Optional[Mapping[str, str]]) – The settings for the option. Default: - no settings

  • version (Optional[str]) – The version for the option. Default: - no version

  • vpc (Optional[IVpc]) – The VPC where a security group should be created for this option. If vpc is specified then port must also be specified. Default: - no VPC

Return type:

bool

Returns:

true if the OptionConfiguration was successfully added.

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters:

policy (RemovalPolicy)

Return type:

None

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The tree node.

option_group_name

The name of the option group.

Attribute:

true

stack

The stack in which this resource is defined.