aws-cdk-lib.aws_secretsmanager.MultiUserHostedRotationOptions

interface MultiUserHostedRotationOptions

LanguageType name
.NETAmazon.CDK.AWS.SecretsManager.MultiUserHostedRotationOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssecretsmanager#MultiUserHostedRotationOptions
Javasoftware.amazon.awscdk.services.secretsmanager.MultiUserHostedRotationOptions
Pythonaws_cdk.aws_secretsmanager.MultiUserHostedRotationOptions
TypeScript (source)aws-cdk-lib » aws_secretsmanager » MultiUserHostedRotationOptions

Multi user hosted rotation options.

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

NameTypeDescription
masterSecretISecretThe master secret for a multi user rotation scheme.
excludeCharacters?stringA string of the characters that you don't want in the password.
functionName?stringA name for the Lambda created to rotate the secret.
securityGroups?ISecurityGroup[]A list of security groups for the Lambda created to rotate the secret.
vpc?IVpcThe VPC where the Lambda rotation function will run.
vpcSubnets?SubnetSelectionThe type of subnets in the VPC where the Lambda rotation function will run.

masterSecret

Type: ISecret

The master secret for a multi user rotation scheme.


excludeCharacters?

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

A string of the characters that you don't want in the password.


functionName?

Type: string (optional, default: a CloudFormation generated name)

A name for the Lambda created to rotate the secret.


securityGroups?

Type: ISecurityGroup[] (optional, default: a new security group is created)

A list of security groups for the Lambda created to rotate the secret.


vpc?

Type: IVpc (optional, default: the Lambda is not deployed in a VPC)

The VPC where the Lambda rotation function will run.


vpcSubnets?

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified.)

The type of subnets in the VPC where the Lambda rotation function will run.