MultiUserHostedRotationOptions Struct
Multi user hosted rotation options.
| Source | aws-secretsmanager/lib/rotation-schedule.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_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,
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_secretsmanager as secretsmanager
# secret: secretsmanager.Secret
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc
multi_user_hosted_rotation_options = secretsmanager.MultiUserHostedRotationOptions(
master_secret=secret,
# the properties below are optional
exclude_characters="excludeCharacters",
function_name="functionName",
security_groups=[security_group],
vpc=vpc,
vpc_subnets=ec2.SubnetSelection(
availability_zones=["availabilityZones"],
one_per_az=False,
subnet_filters=[subnet_filter],
subnet_group_name="subnetGroupName",
subnets=[subnet],
subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.secretsmanager.*;
Secret secret;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
MultiUserHostedRotationOptions multiUserHostedRotationOptions = MultiUserHostedRotationOptions.builder()
.masterSecret(secret)
// the properties below are optional
.excludeCharacters("excludeCharacters")
.functionName("functionName")
.securityGroups(List.of(securityGroup))
.vpc(vpc)
.vpcSubnets(SubnetSelection.builder()
.availabilityZones(List.of("availabilityZones"))
.onePerAz(false)
.subnetFilters(List.of(subnetFilter))
.subnetGroupName("subnetGroupName")
.subnets(List.of(subnet))
.subnetType(SubnetType.PRIVATE_ISOLATED)
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.SecretsManager;
Secret secret;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var multiUserHostedRotationOptions = new MultiUserHostedRotationOptions {
MasterSecret = secret,
// the properties below are optional
ExcludeCharacters = "excludeCharacters",
FunctionName = "functionName",
SecurityGroups = new [] { securityGroup },
Vpc = vpc,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var secret Secret
var securityGroup SecurityGroup
var subnet Subnet
var subnetFilter SubnetFilter
var vpc Vpc
multiUserHostedRotationOptions := &MultiUserHostedRotationOptions{
MasterSecret: secret,
// the properties below are optional
ExcludeCharacters: jsii.String("excludeCharacters"),
FunctionName: jsii.String("functionName"),
SecurityGroups: []ISecurityGroup{
securityGroup,
},
Vpc: vpc,
VpcSubnets: &SubnetSelection{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
OnePerAz: jsii.Boolean(false),
SubnetFilters: []SubnetFilter{
subnetFilter,
},
SubnetGroupName: jsii.String("subnetGroupName"),
Subnets: []ISubnet{
subnet,
},
SubnetType: awscdk.Aws_ec2.SubnetType_PRIVATE_ISOLATED,
},
}
Properties
excludeCharactersoptionalstringexclude_charactersoptionalstrexcludeCharactersoptionalStringExcludeCharactersoptionalstringExcludeCharactersoptional*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 " %+~`#$&*()|[]{}:;<>?!'/@"\"
functionNameoptionalstringfunction_nameoptionalstrfunctionNameoptionalStringFunctionNameoptionalstringFunctionNameoptional*string #A name for the Lambda created to rotate the secret.
Default: a CloudFormation generated name
masterSecretISecretmaster_secretISecretmasterSecretISecretMasterSecretISecretMasterSecretISecret required #The master secret for a multi user rotation scheme.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup #A list of security groups for the Lambda created to rotate the secret.
Default: a new security group is created
The VPC where the Lambda rotation function will run.
Default: the Lambda is not deployed in a VPC
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #The type of subnets in the VPC where the Lambda rotation function will run.
Default: the Vpc default strategy if not specified.