AWS CDK Reference

Appearance

v2.274.0

OptionConfiguration Struct ​

Configuration properties for an option.

Source
aws-rds/lib/option-group.ts

Example ​

ts
// 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 ​

namestringnamestrnameStringNamestringName*stringrequired#
The name of the option.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port number that this option uses.

Default: no port

If port is specified then vpc must also be specified.

securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#
Optional list of security groups to use for this option, if `vpc` is specified.

Default: a default group will be created if port or vpc are specified.

If no groups are provided, a default one will be created.

settingsoptional{ [key: string]: string }settingsoptionaltyping.Mapping[str, str]settingsoptionalMap<String, String>SettingsoptionalIDictionary<string, string>Settingsoptional*map[string]*string#
The settings for the option.

Default: no settings

versionoptionalstringversionoptionalstrversionoptionalStringVersionoptionalstringVersionoptional*string#
The version for the option.

Default: no version

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

Default: no VPC

If vpc is specified then port must also be specified.