# MultiUserHostedRotationOptions

Multi user hosted rotation options.

Extends: MultiUserHostedRotationOptions
Extends: SingleUserHostedRotationOptions

- Source: [`aws-secretsmanager/lib/rotation-schedule.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-secretsmanager/lib/rotation-schedule.ts#L221)

## 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_secretsmanager as secretsmanager } from 'aws-cdk-lib';

declare const secret: secretsmanager.Secret;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const multiUserHostedRotationOptions: secretsmanager.MultiUserHostedRotationOptions = {
  masterSecret: secret,

  // the properties below are optional
  excludeCharacters: 'excludeCharacters',
  functionName: 'functionName',
  securityGroups: [securityGroup],
  vpc: vpc,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};
```

## Properties

- `excludeCharacters`: string — A string of the characters that you don't want in the password.

  **Default:** the same exclude characters as the ones used for the secret or " %+~`#$&*()|[]{}:;<>?!'/@\"\\"

- `functionName`: string — A name for the Lambda created to rotate the secret.

  **Default:** a CloudFormation generated name

- `masterSecret`: [ISecret](/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.ISecret.html) (required) — The master secret for a multi user rotation scheme.

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — A list of security groups for the Lambda created to rotate the secret.

  **Default:** a new security group is created

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC where the Lambda rotation function will run.

  **Default:** the Lambda is not deployed in a VPC

- `vpcSubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — The type of subnets in the VPC where the Lambda rotation function will run.

  **Default:** the Vpc default strategy if not specified.