class SecretRotationApplication

Language	Type name
.NET	Amazon.CDK.AWS.SecretsManager.SecretRotationApplication
Java	software.amazon.awscdk.services.secretsmanager.SecretRotationApplication
Python	aws_cdk.aws_secretsmanager.SecretRotationApplication
TypeScript (source)	@aws-cdk/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

Name	Type	Description
applicationId⚠️	string	The application identifier of the rotation application.
semanticVersion⚠️	string	The semantic version of the rotation application.
isMultiUser?	boolean	Whether the rotation application uses the mutli user scheme.
static MARIADB_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.
static MARIADB_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.
static MONGODB_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.
static MONGODB_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.
static MYSQL_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.
static MYSQL_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.
static ORACLE_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.
static ORACLE_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.
static POSTGRES_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.
static POSTGRES_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.
static REDSHIFT_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.
static REDSHIFT_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.
static SQLSERVER_ROTATION_MULTI_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.
static SQLSERVER_ROTATION_SINGLE_USER	SecretRotationApplication	Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the single user rotation scheme.

---

applicationId⚠️

⚠️ Deprecated: only valid when deploying to the 'aws' partition. Use applicationArnForPartition instead.

Type: string

The application identifier of the rotation application.

---

semanticVersion⚠️

⚠️ Deprecated: only valid when deploying to the 'aws' partition. Use semanticVersionForPartition instead.

Type: string

The semantic version of the rotation application.

---

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

Name	Description
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.