software.amazon.awscdk.services.secretsmanager

Interface CfnRotationScheduleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRotationScheduleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-17T13:49:48.886Z")
 @Stability(value=Stable)
public interface CfnRotationScheduleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnRotationSchedule`.

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.*;
 CfnRotationScheduleProps cfnRotationScheduleProps = CfnRotationScheduleProps.builder()
         .secretId("secretId")
         // the properties below are optional
         .hostedRotationLambda(HostedRotationLambdaProperty.builder()
                 .rotationType("rotationType")
                 // the properties below are optional
                 .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	Interface and Description
static class	CfnRotationScheduleProps.Builder A builder for CfnRotationScheduleProps
static class	CfnRotationScheduleProps.Jsii$Proxy An implementation for CfnRotationScheduleProps

Method Summary

Modifier and Type	Method and Description
static CfnRotationScheduleProps.Builder	builder()
default Object	getHostedRotationLambda() To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.
default Object	getRotateImmediatelyOnUpdate() Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
default String	getRotationLambdaArn() The ARN of the Lambda function that can rotate the secret.
default Object	getRotationRules() A structure that defines the rotation configuration for this secret.
String	getSecretId() The ARN or name of the secret to rotate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecretId

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

getHostedRotationLambda

@Stability(value=Stable)
 @Nullable
default Object getHostedRotationLambda()

To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.

When you enter valid values for RotationSchedule.HostedRotationLambda , Secrets Manager launches a Lambda that performs rotation on the secret specified in the secret-id property. The template creates a Lambda as part of a nested stack within the current stack.

getRotateImmediatelyOnUpdate

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

getRotationLambdaArn

@Stability(value=Stable)
 @Nullable
default String getRotationLambdaArn()

The ARN of the Lambda function that can rotate the secret.

If you don't specify this parameter, then the secret must already have the ARN of a Lambda function configured.

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

getRotationRules

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

A structure that defines the rotation configuration for this secret.

builder

@Stability(value=Stable)
static CfnRotationScheduleProps.Builder builder()

Returns:

a CfnRotationScheduleProps.Builder of CfnRotationScheduleProps