Package software.amazon.awscdk.services.secretsmanager

Class CfnRotationScheduleProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.secretsmanager.CfnRotationScheduleProps.Jsii$Proxy

All Implemented Interfaces:

CfnRotationScheduleProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnRotationScheduleProps

@Stability(Stable)
@Internal
public static final class CfnRotationScheduleProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnRotationScheduleProps

An implementation for CfnRotationScheduleProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.CfnRotationScheduleProps

CfnRotationScheduleProps.Builder, CfnRotationScheduleProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnRotationScheduleProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnRotationScheduleProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getHostedRotationLambda()	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates .
final Object	getRotateImmediatelyOnUpdate()	Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.
final String	getRotationLambdaArn()	The ARN of an existing Lambda rotation function.
final Object	getRotationRules()	A structure that defines the rotation configuration for this secret.
final String	getSecretId()	The ARN or name of the secret to rotate.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnRotationScheduleProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnRotationScheduleProps.Builder.

Method Details

getSecretId

public final String getSecretId()

Description copied from interface: CfnRotationScheduleProps

The ARN or name of the secret to rotate. This is unique for each rotation schedule definition.

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

Specified by:

getSecretId in interface CfnRotationScheduleProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-secretid

getHostedRotationLambda

public final Object getHostedRotationLambda()

Description copied from interface: CfnRotationScheduleProps

Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify RotationLambdaARN instead.

You must specify Transform: AWS::SecretsManager-2024-09-16 at the beginning of the CloudFormation template. Transforms are macros hosted by AWS CloudFormation that help you create and manage complex infrastructure. The Transform: AWS::SecretsManager-2024-09-16 transform automatically extends the CloudFormation stack to include a nested stack (of type AWS::CloudFormation::Stack ), which then creates and updates on your behalf during subsequent stack operations, the appropriate rotation Lambda function for your database or service. For general information on transforms, see the AWS CloudFormation documentation.

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

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

Returns union: either IResolvable or CfnRotationSchedule.HostedRotationLambdaProperty

Specified by:

getHostedRotationLambda in interface CfnRotationScheduleProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda

getRotateImmediatelyOnUpdate

public final Object getRotateImmediatelyOnUpdate()

Description copied from interface: CfnRotationScheduleProps

Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.

The rotation schedule is defined in RotationRules .

The default for RotateImmediatelyOnUpdate is true . If you don't specify this value, Secrets Manager rotates the secret immediately.

If you set RotateImmediatelyOnUpdate to false , Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

When changing an existing rotation schedule and setting RotateImmediatelyOnUpdate to false :

• If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the previously scheduled rotation might still occur.
• To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

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

Returns union: either Boolean or IResolvable

Specified by:

getRotateImmediatelyOnUpdate in interface CfnRotationScheduleProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotateimmediatelyonupdate

getRotationLambdaArn

public final String getRotationLambdaArn()

Description copied from interface: CfnRotationScheduleProps

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

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

Specified by:

getRotationLambdaArn in interface CfnRotationScheduleProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationlambdaarn

getRotationRules

public final Object getRotationRules()

Description copied from interface: CfnRotationScheduleProps

A structure that defines the rotation configuration for this secret.

Returns union: either IResolvable or CfnRotationSchedule.RotationRulesProperty

Specified by:

getRotationRules in interface CfnRotationScheduleProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationrules

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object