software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.021Z")
 @Stability(value=Stable)
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 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 Amazon RDS , Amazon Redshift , Amazon DocumentDB 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")
                 .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRotationSchedule(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
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) .
Object	getRotateImmediatelyOnUpdate() Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
String	getRotationLambdaArn() The ARN of an existing Lambda rotation function.
Object	getRotationRules() A structure that defines the rotation configuration for this secret.
String	getSecretId() The ARN or name of the secret to rotate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,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(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(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(String value) The ARN or name of the secret to rotate.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnRotationSchedule(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSecretId

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setSecretId(@NotNull
                                                 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

@Stability(value=Stable)
 @Nullable
public 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.

setHostedRotationLambda

@Stability(value=Stable)
public void setHostedRotationLambda(@Nullable
                                                             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.

setHostedRotationLambda

@Stability(value=Stable)
public void setHostedRotationLambda(@Nullable
                                                             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.

getRotateImmediatelyOnUpdate

@Stability(value=Stable)
 @Nullable
public 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.

setRotateImmediatelyOnUpdate

@Stability(value=Stable)
public void setRotateImmediatelyOnUpdate(@Nullable
                                                                  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.

setRotateImmediatelyOnUpdate

@Stability(value=Stable)
public void setRotateImmediatelyOnUpdate(@Nullable
                                                                  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.

getRotationLambdaArn

@Stability(value=Stable)
 @Nullable
public 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.

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

setRotationLambdaArn

@Stability(value=Stable)
public void setRotationLambdaArn(@Nullable
                                                          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.

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

getRotationRules

@Stability(value=Stable)
 @Nullable
public Object getRotationRules()

A structure that defines the rotation configuration for this secret.

setRotationRules

@Stability(value=Stable)
public void setRotationRules(@Nullable
                                                      CfnRotationSchedule.RotationRulesProperty value)

A structure that defines the rotation configuration for this secret.

setRotationRules

@Stability(value=Stable)
public void setRotationRules(@Nullable
                                                      IResolvable value)

A structure that defines the rotation configuration for this secret.