aws-cdk-lib.aws_secretsmanager.SecretRotationApplication

class SecretRotationApplication

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

A secret rotation serverless application.

Example

declare const mySecret: secretsmanager.Secret;
declare const myDatabase: ec2.IConnectable;
declare const myVpc: ec2.Vpc;

new secretsmanager.SecretRotation(this, 'SecretRotation', {
  application: secretsmanager.SecretRotationApplication.MYSQL_ROTATION_SINGLE_USER, // MySQL single user scheme
  secret: mySecret,
  target: myDatabase, // a Connectable
  vpc: myVpc, // The VPC where the secret rotation application will be deployed
  excludeCharacters: ' %+:;{}', // characters to never use when generating new passwords;
                                // by default, no characters are excluded,
                                // which might cause problems with some services, like DMS
});

Initializer

new SecretRotationApplication(applicationId: string, semanticVersion: string, options?: SecretRotationApplicationOptions)

Parameters

  • applicationId string
  • semanticVersion string
  • options SecretRotationApplicationOptions

Properties

NameTypeDescription
isMultiUser?booleanWhether the rotation application uses the mutli user scheme.
static MARIADB_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.
static MARIADB_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.
static MONGODB_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.
static MONGODB_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.
static MYSQL_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.
static MYSQL_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.
static ORACLE_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.
static ORACLE_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.
static POSTGRES_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.
static POSTGRES_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.
static REDSHIFT_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.
static REDSHIFT_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.
static SQLSERVER_ROTATION_MULTI_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.
static SQLSERVER_ROTATION_SINGLE_USERSecretRotationApplicationConducts an AWS SecretsManager secret rotation for RDS SQL Server using the single user rotation scheme.

isMultiUser?

Type: boolean (optional)

Whether the rotation application uses the mutli user scheme.


static MARIADB_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.


static MARIADB_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.


static MONGODB_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.


static MONGODB_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.


static MYSQL_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.


static MYSQL_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.


static ORACLE_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.


static ORACLE_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.


static POSTGRES_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.


static POSTGRES_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.


static REDSHIFT_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.


static REDSHIFT_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.


static SQLSERVER_ROTATION_MULTI_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.


static SQLSERVER_ROTATION_SINGLE_USER

Type: SecretRotationApplication

Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the single user rotation scheme.

Methods

NameDescription
applicationArnForPartition(partition)Returns the application ARN for the current partition.
semanticVersionForPartition(partition)The semantic version of the app for the current partition.

applicationArnForPartition(partition)

public applicationArnForPartition(partition: string): string

Parameters

  • partition string

Returns

  • string

Returns the application ARN for the current partition.

Can be used in combination with a CfnMapping to automatically select the correct ARN based on the current partition.


semanticVersionForPartition(partition)

public semanticVersionForPartition(partition: string): string

Parameters

  • partition string

Returns

  • string

The semantic version of the app for the current partition.

Can be used in combination with a CfnMapping to automatically select the correct version based on the current partition.