SecretRotationApplication

class aws_cdk.aws_secretsmanager.SecretRotationApplication(application_name, aws_semantic_version, *, additional_semantic_versions=None, is_multi_user=None)

Bases: object

A secret rotation serverless application.

ExampleMetadata:

infused

Example:

# my_user_secret: secretsmanager.Secret
# my_master_secret: secretsmanager.Secret
# my_database: ec2.IConnectable
# my_vpc: ec2.Vpc


secretsmanager.SecretRotation(self, "SecretRotation",
    application=secretsmanager.SecretRotationApplication.MYSQL_ROTATION_MULTI_USER,
    secret=my_user_secret,  # The secret that will be rotated
    master_secret=my_master_secret,  # The secret used for the rotation
    target=my_database,
    vpc=my_vpc
)
Parameters:
  • application_name (str) –

    • The name of the rotation application.

  • aws_semantic_version (str) –

    • AWS partition semantic version for the application.

  • additional_semantic_versions (Optional[Mapping[str, str]]) – Semantic versions for partitions other than ‘aws’. If not specified, it is assumed that non aws partitions (eg aws-cn, aws-us-gov) are not supported. Default: - no additional partition versions (only ‘aws’ partition is supported)

  • is_multi_user (Optional[bool]) – Whether the rotation application uses the multi user scheme. Default: false

Methods

application_arn_for_partition(partition)

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.

Parameters:

partition (str)

Return type:

str

semantic_version_for_partition(partition)

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.

Parameters:

partition (str)

Return type:

str

Attributes

DB2_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
DB2_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MARIADB_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MARIADB_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MONGODB_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MONGODB_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MYSQL_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
MYSQL_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
ORACLE_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
ORACLE_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
POSTGRES_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
POSTGRES_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
REDSHIFT_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
REDSHIFT_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
SQLSERVER_ROTATION_MULTI_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
SQLSERVER_ROTATION_SINGLE_USER = <aws_cdk.aws_secretsmanager.SecretRotationApplication object>
is_multi_user

Whether the rotation application uses the multi user scheme.