interface OptionConfiguration

Language	Type name
.NET	Amazon.CDK.AWS.RDS.OptionConfiguration
Java	software.amazon.awscdk.services.rds.OptionConfiguration
Python	aws_cdk.aws_rds.OptionConfiguration
TypeScript (source)	@aws-cdk/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 * as ec2 from '@aws-cdk/aws-ec2';
import * as rds from '@aws-cdk/aws-rds';

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

Name	Type	Description
name	string	The name of the option.
port?	number	The 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?	string	The version for the option.
vpc?	IVpc	The 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.