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[List[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

Attributes

name

The name of the option.

Return type

str

port

The port number that this option uses.

If port is specified then vpc must also be specified.

Default
  • no port

Return type

Union[int, float, None]

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.

Return type

Optional[List[ISecurityGroup]]

settings

The settings for the option.

Default
  • no settings

Return type

Optional[Mapping[str, str]]

version

The version for the option.

Default
  • no version

Return type

Optional[str]

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

Return type

Optional[IVpc]