CommonRotationUserOptions Struct
Properties common to single-user and multi-user rotation options.
| Source | aws-rds/lib/props.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';
declare const interfaceVpcEndpoint: ec2.InterfaceVpcEndpoint;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
const commonRotationUserOptions: rds.CommonRotationUserOptions = {
automaticallyAfter: cdk.Duration.minutes(30),
endpoint: interfaceVpcEndpoint,
excludeCharacters: 'excludeCharacters',
rotateImmediatelyOnUpdate: false,
securityGroup: securityGroup,
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.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_rds as rds
# interface_vpc_endpoint: ec2.InterfaceVpcEndpoint
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
common_rotation_user_options = rds.CommonRotationUserOptions(
automatically_after=cdk.Duration.minutes(30),
endpoint=interface_vpc_endpoint,
exclude_characters="excludeCharacters",
rotate_immediately_on_update=False,
security_group=security_group,
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.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.rds.*;
InterfaceVpcEndpoint interfaceVpcEndpoint;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
CommonRotationUserOptions commonRotationUserOptions = CommonRotationUserOptions.builder()
.automaticallyAfter(Duration.minutes(30))
.endpoint(interfaceVpcEndpoint)
.excludeCharacters("excludeCharacters")
.rotateImmediatelyOnUpdate(false)
.securityGroup(securityGroup)
.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;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.RDS;
InterfaceVpcEndpoint interfaceVpcEndpoint;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
var commonRotationUserOptions = new CommonRotationUserOptions {
AutomaticallyAfter = Duration.Minutes(30),
Endpoint = interfaceVpcEndpoint,
ExcludeCharacters = "excludeCharacters",
RotateImmediatelyOnUpdate = false,
SecurityGroup = securityGroup,
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 cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var interfaceVpcEndpoint InterfaceVpcEndpoint
var securityGroup SecurityGroup
var subnet Subnet
var subnetFilter SubnetFilter
commonRotationUserOptions := &CommonRotationUserOptions{
AutomaticallyAfter: cdk.Duration_Minutes(jsii.Number(30)),
Endpoint: interfaceVpcEndpoint,
ExcludeCharacters: jsii.String("excludeCharacters"),
RotateImmediatelyOnUpdate: jsii.Boolean(false),
SecurityGroup: securityGroup,
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
automaticallyAfteroptionalDurationautomatically_afteroptionalDurationautomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDuration #Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
Default: 30 days
endpointoptionalIInterfaceVpcEndpointendpointoptionalIInterfaceVpcEndpointendpointoptionalIInterfaceVpcEndpointEndpointoptionalIInterfaceVpcEndpointEndpointoptionalIInterfaceVpcEndpoint #The VPC interface endpoint to use for the Secrets Manager API.
Default: https://secretsmanager.<region>.amazonaws.com
notes
If you enable private DNS hostnames for your VPC private endpoint (the default), you don't need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager CLI and SDKs use by default (https://secretsmanager.<region>.amazonaws.com) automatically resolves to your VPC endpoint.
excludeCharactersoptionalstringexclude_charactersoptionalstrexcludeCharactersoptionalStringExcludeCharactersoptionalstringExcludeCharactersoptional*string #Specifies characters to not include in generated passwords.
Default: " %+~`#$&*()|[]{}:;<>?!'/@"\"
rotateImmediatelyOnUpdateoptionalbooleanrotate_immediately_on_updateoptionalboolrotateImmediatelyOnUpdateoptionalBooleanRotateImmediatelyOnUpdateoptionalboolRotateImmediatelyOnUpdateoptional*bool = true #Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup #The security group for the Lambda rotation function.
Default: a new security group is created
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #Where to place the rotation Lambda function.
Default: same placement as instance or cluster