aws-cdk-lib.aws_secretsmanager.HostedRotation

class HostedRotation

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

Implements IConnectable

A hosted rotation.

Example

const secret = new secretsmanager.Secret(this, 'Secret');

secret.addRotationSchedule('RotationSchedule', {
  hostedRotation: secretsmanager.HostedRotation.mysqlSingleUser(),
  rotateImmediatelyOnUpdate: false, // by default, Secrets Manager rotates the secret immediately
});

Properties

NameTypeDescription
connectionsConnectionsSecurity group connections for this hosted rotation.

connections

Type: Connections

Security group connections for this hosted rotation.

Methods

NameDescription
bind(secret, scope)Binds this hosted rotation to a secret.
static mariaDbMultiUser(options)MariaDB Multi User.
static mariaDbSingleUser(options?)MariaDB Single User.
static mongoDbMultiUser(options)MongoDB Multi User.
static mongoDbSingleUser(options?)MongoDB Single User.
static mysqlMultiUser(options)MySQL Multi User.
static mysqlSingleUser(options?)MySQL Single User.
static oracleMultiUser(options)Oracle Multi User.
static oracleSingleUser(options?)Oracle Single User.
static postgreSqlMultiUser(options)PostgreSQL Multi User.
static postgreSqlSingleUser(options?)PostgreSQL Single User.
static redshiftMultiUser(options)Redshift Multi User.
static redshiftSingleUser(options?)Redshift Single User.
static sqlServerMultiUser(options)SQL Server Multi User.
static sqlServerSingleUser(options?)SQL Server Single User.

bind(secret, scope)

public bind(secret: ISecret, scope: Construct): HostedRotationLambdaProperty

Parameters

  • secret ISecret
  • scope Construct

Returns

  • HostedRotationLambdaProperty

Binds this hosted rotation to a secret.


static mariaDbMultiUser(options)

public static mariaDbMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

MariaDB Multi User.


static mariaDbSingleUser(options?)

public static mariaDbSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

MariaDB Single User.


static mongoDbMultiUser(options)

public static mongoDbMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

MongoDB Multi User.


static mongoDbSingleUser(options?)

public static mongoDbSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

MongoDB Single User.


static mysqlMultiUser(options)

public static mysqlMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

MySQL Multi User.


static mysqlSingleUser(options?)

public static mysqlSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

MySQL Single User.


static oracleMultiUser(options)

public static oracleMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

Oracle Multi User.


static oracleSingleUser(options?)

public static oracleSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

Oracle Single User.


static postgreSqlMultiUser(options)

public static postgreSqlMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

PostgreSQL Multi User.


static postgreSqlSingleUser(options?)

public static postgreSqlSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

PostgreSQL Single User.


static redshiftMultiUser(options)

public static redshiftMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

Redshift Multi User.


static redshiftSingleUser(options?)

public static redshiftSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

Redshift Single User.


static sqlServerMultiUser(options)

public static sqlServerMultiUser(options: MultiUserHostedRotationOptions): HostedRotation

Parameters

  • options MultiUserHostedRotationOptions

Returns

  • HostedRotation

SQL Server Multi User.


static sqlServerSingleUser(options?)

public static sqlServerSingleUser(options?: SingleUserHostedRotationOptions): HostedRotation

Parameters

  • options SingleUserHostedRotationOptions

Returns

  • HostedRotation

SQL Server Single User.