aws-cdk-lib.aws_rds.OptionConfiguration

interface OptionConfiguration

LanguageType name
.NETAmazon.CDK.AWS.RDS.OptionConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#OptionConfiguration
Javasoftware.amazon.awscdk.services.rds.OptionConfiguration
Pythonaws_cdk.aws_rds.OptionConfiguration
TypeScript (source)aws-cdk-lib » aws_rds » OptionConfiguration

Configuration properties for an option.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const securityGroup: ec2.SecurityGroup;
declare const vpc: ec2.Vpc;
const optionConfiguration: rds.OptionConfiguration = {
  name: 'name',

  // the properties below are optional
  port: 123,
  securityGroups: [securityGroup],
  settings: {
    settingsKey: 'settings',
  },
  version: 'version',
  vpc: vpc,
};

Properties

NameTypeDescription
namestringThe name of the option.
port?numberThe port number that this option uses.
securityGroups?ISecurityGroup[]Optional list of security groups to use for this option, if vpc is specified.
settings?{ [string]: string }The settings for the option.
version?stringThe version for the option.
vpc?IVpcThe VPC where a security group should be created for this option.

name

Type: string

The name of the option.


port?

Type: number (optional, default: no port)

The port number that this option uses.

If port is specified then vpc must also be specified.


securityGroups?

Type: ISecurityGroup[] (optional, default: a default group will be created if port or vpc are specified.)

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.


settings?

Type: { [string]: string } (optional, default: no settings)

The settings for the option.


version?

Type: string (optional, default: no version)

The version for the option.


vpc?

Type: IVpc (optional, default: no VPC)

The VPC where a security group should be created for this option.

If vpc is specified then port must also be specified.