Package software.amazon.awscdk.services.secretsmanager

Interface SingleUserHostedRotationOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

MultiUserHostedRotationOptions

All Known Implementing Classes:

MultiUserHostedRotationOptions.Jsii$Proxy, SingleUserHostedRotationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:27.120Z")
@Stability(Stable)
public interface SingleUserHostedRotationOptions
extends software.amazon.jsii.JsiiSerializable

Single user hosted rotation options.

Example:

 IVpc myVpc;
 Connections dbConnections;
 Secret secret;
 HostedRotation myHostedRotation = HostedRotation.mysqlSingleUser(SingleUserHostedRotationOptions.builder().vpc(myVpc).build());
 secret.addRotationSchedule("RotationSchedule", RotationScheduleOptions.builder().hostedRotation(myHostedRotation).build());
 dbConnections.allowDefaultPortFrom(myHostedRotation);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SingleUserHostedRotationOptions.Builder	A builder for SingleUserHostedRotationOptions
static final class	SingleUserHostedRotationOptions.Jsii$Proxy	An implementation for SingleUserHostedRotationOptions

Method Summary

Modifier and Type	Method	Description
static SingleUserHostedRotationOptions.Builder	builder()
default String	getExcludeCharacters()	A string of the characters that you don't want in the password.
default String	getFunctionName()	A name for the Lambda created to rotate the secret.
default List<ISecurityGroup>	getSecurityGroups()	A list of security groups for the Lambda created to rotate the secret.
default IVpc	getVpc()	The VPC where the Lambda rotation function will run.
default SubnetSelection	getVpcSubnets()	The type of subnets in the VPC where the Lambda rotation function will run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExcludeCharacters

@Stability(Stable)
@Nullable
default String getExcludeCharacters()

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 " %+~`#$invalid input: '&'*()|[]{}:;invalid input: '<'>?!'/@\"\\"

getFunctionName

@Stability(Stable)
@Nullable
default String getFunctionName()

A name for the Lambda created to rotate the secret.

Default: - a CloudFormation generated name

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

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

Default: - a new security group is created

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC where the Lambda rotation function will run.

Default: - the Lambda is not deployed in a VPC

getVpcSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getVpcSubnets()

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

Default: - the Vpc default strategy if not specified.

builder

@Stability(Stable)
static SingleUserHostedRotationOptions.Builder builder()

Returns:

a SingleUserHostedRotationOptions.Builder of SingleUserHostedRotationOptions