OptionConfiguration

class aws_cdk.aws_rds.OptionConfiguration(*, name, port=None, security_groups=None, settings=None, version=None, vpc=None)

Bases: object

Configuration properties for an option.

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

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_ec2 as ec2
from aws_cdk import aws_rds as rds

# security_group: ec2.SecurityGroup
# vpc: ec2.Vpc

option_configuration = rds.OptionConfiguration(
    name="name",

    # the properties below are optional
    port=123,
    security_groups=[security_group],
    settings={
        "settings_key": "settings"
    },
    version="version",
    vpc=vpc
)

Attributes

name: The name of the option.

port

The port number that this option uses.

If port is specified then vpc must also be specified.

Default:

no port

security_groups

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

The settings for the option.

Default:

no settings

version

The version for the option.

Default:

no version

vpc

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