software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.571Z")
public class CfnRotationSchedule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SecretsManager::RotationSchedule`.

Sets the rotation schedule and Lambda rotation function for a secret. For more information, see How rotation works .

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For the rotation function, you have two options:

• You can create a new rotation function based on one of the Secrets Manager rotation function templates by using HostedRotationLambda .
• You can choose an existing rotation function by using RotationLambdaARN .

For database secrets, if you define both the secret and the database or service in the AWS CloudFormation template, then you need to define the AWS::SecretsManager::SecretTargetAttachment resource to populate the secret with the connection details of the database or service before you attempt to configure rotation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.secretsmanager.*;
 CfnRotationSchedule cfnRotationSchedule = CfnRotationSchedule.Builder.create(this, "MyCfnRotationSchedule")
         .secretId("secretId")
         // the properties below are optional
         .hostedRotationLambda(HostedRotationLambdaProperty.builder()
                 .rotationType("rotationType")
                 // the properties below are optional
                 .excludeCharacters("excludeCharacters")
                 .kmsKeyArn("kmsKeyArn")
                 .masterSecretArn("masterSecretArn")
                 .masterSecretKmsKeyArn("masterSecretKmsKeyArn")
                 .rotationLambdaName("rotationLambdaName")
                 .runtime("runtime")
                 .superuserSecretArn("superuserSecretArn")
                 .superuserSecretKmsKeyArn("superuserSecretKmsKeyArn")
                 .vpcSecurityGroupIds("vpcSecurityGroupIds")
                 .vpcSubnetIds("vpcSubnetIds")
                 .build())
         .rotateImmediatelyOnUpdate(false)
         .rotationLambdaArn("rotationLambdaArn")
         .rotationRules(RotationRulesProperty.builder()
                 .automaticallyAfterDays(123)
                 .duration("duration")
                 .scheduleExpression("scheduleExpression")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRotationSchedule.Builder A fluent builder for CfnRotationSchedule.
static interface	CfnRotationSchedule.HostedRotationLambdaProperty Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
static interface	CfnRotationSchedule.RotationRulesProperty The rotation schedule and window.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRotationSchedule(Construct scope, java.lang.String id, CfnRotationScheduleProps props) Create a new `AWS::SecretsManager::RotationSchedule`.
protected	CfnRotationSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRotationSchedule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getHostedRotationLambda() Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
java.lang.Object	getRotateImmediatelyOnUpdate() Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
java.lang.String	getRotationLambdaArn() The ARN of an existing Lambda rotation function.
java.lang.Object	getRotationRules() A structure that defines the rotation configuration for this secret.
java.lang.String	getSecretId() The ARN or name of the secret to rotate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setHostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty value) Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
void	setHostedRotationLambda(IResolvable value) Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
void	setRotateImmediatelyOnUpdate(java.lang.Boolean value) Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
void	setRotateImmediatelyOnUpdate(IResolvable value) Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
void	setRotationLambdaArn(java.lang.String value) The ARN of an existing Lambda rotation function.
void	setRotationRules(CfnRotationSchedule.RotationRulesProperty value) A structure that defines the rotation configuration for this secret.
void	setRotationRules(IResolvable value) A structure that defines the rotation configuration for this secret.
void	setSecretId(java.lang.String value) The ARN or name of the secret to rotate.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRotationSchedule

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

CfnRotationSchedule

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

CfnRotationSchedule

public CfnRotationSchedule(Construct scope,
                           java.lang.String id,
                           CfnRotationScheduleProps props)

Create a new `AWS::SecretsManager::RotationSchedule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSecretId

public java.lang.String getSecretId()

The ARN or name of the secret to rotate.

To reference a secret also created in this template, use the Ref function with the secret's logical ID.

setSecretId

public void setSecretId(java.lang.String value)

The ARN or name of the secret to rotate.

To reference a secret also created in this template, use the Ref function with the secret's logical ID.

getHostedRotationLambda

public java.lang.Object getHostedRotationLambda()

Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

setHostedRotationLambda

public void setHostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty value)

Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

setHostedRotationLambda

public void setHostedRotationLambda(IResolvable value)

Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

getRotateImmediatelyOnUpdate

public java.lang.Object getRotateImmediatelyOnUpdate()

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

The rotation schedule is defined in RotationRules .

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Rotation is an asynchronous process. For more information, see How rotation works .

setRotateImmediatelyOnUpdate

public void setRotateImmediatelyOnUpdate(java.lang.Boolean value)

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

The rotation schedule is defined in RotationRules .

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Rotation is an asynchronous process. For more information, see How rotation works .

setRotateImmediatelyOnUpdate

public void setRotateImmediatelyOnUpdate(IResolvable value)

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

The rotation schedule is defined in RotationRules .

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Rotation is an asynchronous process. For more information, see How rotation works .

getRotationLambdaArn

public java.lang.String getRotationLambdaArn()

The ARN of an existing Lambda rotation function.

To specify a rotation function that is also defined in this template, use the Ref function.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

To create a new rotation function based on one of the Secrets Manager rotation function templates , specify HostedRotationLambda instead.

setRotationLambdaArn

public void setRotationLambdaArn(java.lang.String value)

The ARN of an existing Lambda rotation function.

To specify a rotation function that is also defined in this template, use the Ref function.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

To create a new rotation function based on one of the Secrets Manager rotation function templates , specify HostedRotationLambda instead.

getRotationRules

public java.lang.Object getRotationRules()

A structure that defines the rotation configuration for this secret.

setRotationRules

public void setRotationRules(IResolvable value)

A structure that defines the rotation configuration for this secret.

setRotationRules

public void setRotationRules(CfnRotationSchedule.RotationRulesProperty value)

A structure that defines the rotation configuration for this secret.