software.amazon.awscdk.services.secretsmanager

Class SecretRotationApplication

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.secretsmanager.SecretRotationApplication

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:23.806Z")
public class SecretRotationApplication
extends software.amazon.jsii.JsiiObject

A secret rotation serverless application.

Example:

 Secret mySecret;
 IConnectable myDatabase;
 Vpc myVpc;
 SecretRotation.Builder.create(this, "SecretRotation")
         .application(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(" %+:;{}")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretRotationApplication.Builder A fluent builder for SecretRotationApplication.

Field Summary

Fields

Modifier and Type	Field and Description
static SecretRotationApplication	MARIADB_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.
static SecretRotationApplication	MARIADB_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.
static SecretRotationApplication	MONGODB_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.
static SecretRotationApplication	MONGODB_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.
static SecretRotationApplication	MYSQL_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.
static SecretRotationApplication	MYSQL_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.
static SecretRotationApplication	ORACLE_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.
static SecretRotationApplication	ORACLE_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.
static SecretRotationApplication	POSTGRES_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.
static SecretRotationApplication	POSTGRES_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.
static SecretRotationApplication	REDSHIFT_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.
static SecretRotationApplication	REDSHIFT_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.
static SecretRotationApplication	SQLSERVER_ROTATION_MULTI_USER Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.
static SecretRotationApplication	SQLSERVER_ROTATION_SINGLE_USER Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the single user rotation scheme.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecretRotationApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SecretRotationApplication(software.amazon.jsii.JsiiObjectRef objRef)
	SecretRotationApplication(java.lang.String applicationId, java.lang.String semanticVersion)
	SecretRotationApplication(java.lang.String applicationId, java.lang.String semanticVersion, SecretRotationApplicationOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	applicationArnForPartition(java.lang.String partition) Returns the application ARN for the current partition.
java.lang.String	getApplicationId() Deprecated. only valid when deploying to the 'aws' partition. Use `applicationArnForPartition` instead.
java.lang.Boolean	getIsMultiUser() Whether the rotation application uses the mutli user scheme.
java.lang.String	getSemanticVersion() Deprecated. only valid when deploying to the 'aws' partition. Use `semanticVersionForPartition` instead.
java.lang.String	semanticVersionForPartition(java.lang.String partition) The semantic version of the app for the current partition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MARIADB_ROTATION_MULTI_USER

public static final SecretRotationApplication MARIADB_ROTATION_MULTI_USER

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

MARIADB_ROTATION_SINGLE_USER

public static final SecretRotationApplication MARIADB_ROTATION_SINGLE_USER

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

MONGODB_ROTATION_MULTI_USER

public static final SecretRotationApplication MONGODB_ROTATION_MULTI_USER

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

MONGODB_ROTATION_SINGLE_USER

public static final SecretRotationApplication MONGODB_ROTATION_SINGLE_USER

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

MYSQL_ROTATION_MULTI_USER

public static final SecretRotationApplication MYSQL_ROTATION_MULTI_USER

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

MYSQL_ROTATION_SINGLE_USER

public static final SecretRotationApplication MYSQL_ROTATION_SINGLE_USER

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

ORACLE_ROTATION_MULTI_USER

public static final SecretRotationApplication ORACLE_ROTATION_MULTI_USER

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

ORACLE_ROTATION_SINGLE_USER

public static final SecretRotationApplication ORACLE_ROTATION_SINGLE_USER

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

POSTGRES_ROTATION_MULTI_USER

public static final SecretRotationApplication POSTGRES_ROTATION_MULTI_USER

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

POSTGRES_ROTATION_SINGLE_USER

public static final SecretRotationApplication POSTGRES_ROTATION_SINGLE_USER

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

REDSHIFT_ROTATION_MULTI_USER

public static final SecretRotationApplication REDSHIFT_ROTATION_MULTI_USER

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

REDSHIFT_ROTATION_SINGLE_USER

public static final SecretRotationApplication REDSHIFT_ROTATION_SINGLE_USER

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

SQLSERVER_ROTATION_MULTI_USER

public static final SecretRotationApplication SQLSERVER_ROTATION_MULTI_USER

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

SQLSERVER_ROTATION_SINGLE_USER

public static final SecretRotationApplication SQLSERVER_ROTATION_SINGLE_USER

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

Constructor Detail

SecretRotationApplication

protected SecretRotationApplication(software.amazon.jsii.JsiiObjectRef objRef)

SecretRotationApplication

protected SecretRotationApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SecretRotationApplication

public SecretRotationApplication(java.lang.String applicationId,
                                 java.lang.String semanticVersion,
                                 SecretRotationApplicationOptions options)

Parameters:

applicationId - This parameter is required.

semanticVersion - This parameter is required.

options -

SecretRotationApplication

public SecretRotationApplication(java.lang.String applicationId,
                                 java.lang.String semanticVersion)

Parameters:

applicationId - This parameter is required.

semanticVersion - This parameter is required.

Method Detail

applicationArnForPartition

public java.lang.String applicationArnForPartition(java.lang.String 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 - This parameter is required.

semanticVersionForPartition

public java.lang.String semanticVersionForPartition(java.lang.String 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 - This parameter is required.

getApplicationId

@Deprecated
public java.lang.String getApplicationId()

Deprecated. only valid when deploying to the 'aws' partition. Use `applicationArnForPartition` instead.

(deprecated) The application identifier of the rotation application.

getSemanticVersion

@Deprecated
public java.lang.String getSemanticVersion()

Deprecated. only valid when deploying to the 'aws' partition. Use `semanticVersionForPartition` instead.

(deprecated) The semantic version of the rotation application.

getIsMultiUser

public java.lang.Boolean getIsMultiUser()

Whether the rotation application uses the mutli user scheme.