# OptionConfiguration

Configuration properties for an option.

- Source: [`aws-rds/lib/option-group.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-rds/lib/option-group.ts#L39)

## 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

- `name`: string (required) — The name of the option.

- `port`: number — The port number that this option uses.

  **Default:** no port

  If `port` is specified then `vpc`
  must also be specified.

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — 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.

- `settings`: { [key: string]: string } — The settings for the option.

  **Default:** no settings

- `version`: string — The version for the option.

  **Default:** no version

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — 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.