Package software.amazon.awscdk.services.secretsmanager

Class SecretRotationApplication

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.secretsmanager.SecretRotationApplication

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:41.309Z")
@Stability(Stable)
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	Description
static final class	SecretRotationApplication.Builder	A fluent builder for SecretRotationApplication.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final SecretRotationApplication	MARIADB_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the multi user rotation scheme.
static final SecretRotationApplication	MARIADB_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for RDS MariaDB using the single user rotation scheme.
static final SecretRotationApplication	MONGODB_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for MongoDB using the multi user rotation scheme.
static final SecretRotationApplication	MONGODB_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for MongoDB using the single user rotation scheme.
static final SecretRotationApplication	MYSQL_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for RDS MySQL using the multi user rotation scheme.
static final SecretRotationApplication	MYSQL_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for RDS MySQL using the single user rotation scheme.
static final SecretRotationApplication	ORACLE_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for RDS Oracle using the multi user rotation scheme.
static final SecretRotationApplication	ORACLE_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for RDS Oracle using the single user rotation scheme.
static final SecretRotationApplication	POSTGRES_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the multi user rotation scheme.
static final SecretRotationApplication	POSTGRES_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for RDS PostgreSQL using the single user rotation scheme.
static final SecretRotationApplication	REDSHIFT_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the multi user rotation scheme.
static final SecretRotationApplication	REDSHIFT_ROTATION_SINGLE_USER	Conducts an AWS SecretsManager secret rotation for Amazon Redshift using the single user rotation scheme.
static final SecretRotationApplication	SQLSERVER_ROTATION_MULTI_USER	Conducts an AWS SecretsManager secret rotation for RDS SQL Server using the multi user rotation scheme.
static final 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	Description
	SecretRotationApplication(String applicationId, String semanticVersion)
	SecretRotationApplication(String applicationId, String semanticVersion, SecretRotationApplicationOptions options)
protected	SecretRotationApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SecretRotationApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

MARIADB_ROTATION_MULTI_USER

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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 Details

SecretRotationApplication

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

SecretRotationApplication

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

SecretRotationApplication

@Stability(Stable)
public SecretRotationApplication(@NotNull
 String applicationId,
 @NotNull
 String semanticVersion,
 @Nullable
 SecretRotationApplicationOptions options)

Parameters:

applicationId - This parameter is required.

semanticVersion - This parameter is required.

options -

SecretRotationApplication

@Stability(Stable)
public SecretRotationApplication(@NotNull
 String applicationId,
 @NotNull
 String semanticVersion)

Parameters:

applicationId - This parameter is required.

semanticVersion - This parameter is required.

Method Details

applicationArnForPartition

@Stability(Stable)
@NotNull
public String applicationArnForPartition(@NotNull
 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

@Stability(Stable)
@NotNull
public String semanticVersionForPartition(@NotNull
 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

@Stability(Deprecated)
@Deprecated
@NotNull
public String getApplicationId()

Deprecated.

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

(deprecated) The application identifier of the rotation application.

getSemanticVersion

@Stability(Deprecated)
@Deprecated
@NotNull
public String getSemanticVersion()

Deprecated.

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

(deprecated) The semantic version of the rotation application.

getIsMultiUser

@Stability(Stable)
@Nullable
public Boolean getIsMultiUser()

Whether the rotation application uses the mutli user scheme.