Package software.amazon.awscdk.cfnpropertymixins.services.secretsmanager

Class CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.secretsmanager.CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty>

Enclosing interface:

CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty

@Stability(Stable)
public static final class CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty>

A builder for CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty	build()	Builds the configured instance.
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	excludeCharacters(String excludeCharacters)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getExcludeCharacters()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	kmsKeyArn(String kmsKeyArn)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getKmsKeyArn()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	masterSecretArn(String masterSecretArn)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getMasterSecretArn()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	masterSecretKmsKeyArn(String masterSecretKmsKeyArn)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getMasterSecretKmsKeyArn()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	rotationLambdaName(String rotationLambdaName)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRotationLambdaName()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	rotationType(String rotationType)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRotationType()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	runtime(String runtime)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRuntime()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	superuserSecretArn(String superuserSecretArn)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getSuperuserSecretArn()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	superuserSecretKmsKeyArn(String superuserSecretKmsKeyArn)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getSuperuserSecretKmsKeyArn()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	vpcSecurityGroupIds(String vpcSecurityGroupIds)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getVpcSecurityGroupIds()
CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder	vpcSubnetIds(String vpcSubnetIds)	Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getVpcSubnetIds()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

excludeCharacters

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder excludeCharacters(String excludeCharacters)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getExcludeCharacters()

Parameters:

excludeCharacters - A string of the characters that you don't want in the password.

Returns:

this

kmsKeyArn

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getKmsKeyArn()

Parameters:

kmsKeyArn - The ARN of the KMS key that Secrets Manager uses to encrypt the secret. If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager . If aws/secretsmanager doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.

Returns:

this

masterSecretArn

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder masterSecretArn(String masterSecretArn)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getMasterSecretArn()

Parameters:

masterSecretArn - The ARN of the secret that contains superuser credentials, if you use the Alternating users rotation strategy . CloudFormation grants the execution role for the Lambda rotation function GetSecretValue permission to the secret in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager . You must create the superuser secret before you can set this property.

You must also include the superuser secret ARN as a key in the JSON of the rotating secret so that the Lambda rotation function can find it. CloudFormation does not hardcode secret ARNs in the Lambda rotation function, so you can use the function to rotate multiple secrets. For more information, see JSON structure of Secrets Manager secrets .

You can specify MasterSecretArn or SuperuserSecretArn but not both. They represent the same superuser secret.

Returns:

this

masterSecretKmsKeyArn

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder masterSecretKmsKeyArn(String masterSecretKmsKeyArn)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getMasterSecretKmsKeyArn()

Parameters:

masterSecretKmsKeyArn - The ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if you use the alternating users strategy and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key aws/secretsmanager . CloudFormation grants the execution role for the Lambda rotation function Decrypt , DescribeKey , and GenerateDataKey permission to the key in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager . You can specify MasterSecretKmsKeyArn or SuperuserSecretKmsKeyArn but not both. They represent the same superuser secret KMS key .

Returns:

this

rotationLambdaName

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder rotationLambdaName(String rotationLambdaName)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRotationLambdaName()

Parameters:

rotationLambdaName - The name of the Lambda rotation function.

Returns:

this

rotationType

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder rotationType(String rotationType)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRotationType()

Parameters:

rotationType - The rotation template to base the rotation function on, one of the following:.

• Db2SingleUser to use the template SecretsManagerRDSDb2RotationSingleUser .
• Db2MultiUser to use the template SecretsManagerRDSDb2RotationMultiUser .
• MySQLSingleUser to use the template SecretsManagerRDSMySQLRotationSingleUser .
• MySQLMultiUser to use the template SecretsManagerRDSMySQLRotationMultiUser .
• PostgreSQLSingleUser to use the template SecretsManagerRDSPostgreSQLRotationSingleUser
• PostgreSQLMultiUser to use the template SecretsManagerRDSPostgreSQLRotationMultiUser .
• OracleSingleUser to use the template SecretsManagerRDSOracleRotationSingleUser .
• OracleMultiUser to use the template SecretsManagerRDSOracleRotationMultiUser .
• MariaDBSingleUser to use the template SecretsManagerRDSMariaDBRotationSingleUser .
• MariaDBMultiUser to use the template SecretsManagerRDSMariaDBRotationMultiUser .
• SQLServerSingleUser to use the template SecretsManagerRDSSQLServerRotationSingleUser .
• SQLServerMultiUser to use the template SecretsManagerRDSSQLServerRotationMultiUser .
• RedshiftSingleUser to use the template SecretsManagerRedshiftRotationSingleUsr .
• RedshiftMultiUser to use the template SecretsManagerRedshiftRotationMultiUser .
• MongoDBSingleUser to use the template SecretsManagerMongoDBRotationSingleUser .
• MongoDBMultiUser to use the template SecretsManagerMongoDBRotationMultiUser .

Returns:

this

runtime

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder runtime(String runtime)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getRuntime()

Parameters:

runtime -

Do not set this value if you are using Transform: AWS::SecretsManager-2024-09-16 .

Over time, the updated rotation lambda artifacts vended by AWS may not be compatible with the code or shared object files defined in the rotation function deployment package.

Only define the Runtime key if:

• You are using Transform: AWS::SecretsManager-2020-07-23 .
• The code or shared object files defined in the rotation function deployment package are incompatible with Python 3.10.

The Python Runtime version for with the rotation function. By default, CloudFormation deploys Python 3.10 binaries for the rotation function. To use a different version of Python, you must do the following two steps:

• Deploy the matching version Python binaries with your rotation function.
• Set the version number in this field. For example, for Python 3.10, enter python3.10 .

If you only do one of the steps, your rotation function will be incompatible with the binaries. For more information, see Why did my Lambda rotation function fail with a "pg module not found" error .

Returns:

this

superuserSecretArn

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder superuserSecretArn(String superuserSecretArn)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getSuperuserSecretArn()

Parameters:

superuserSecretArn - The ARN of the secret that contains superuser credentials, if you use the Alternating users rotation strategy . CloudFormation grants the execution role for the Lambda rotation function GetSecretValue permission to the secret in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager . You must create the superuser secret before you can set this property.

You must also include the superuser secret ARN as a key in the JSON of the rotating secret so that the Lambda rotation function can find it. CloudFormation does not hardcode secret ARNs in the Lambda rotation function, so you can use the function to rotate multiple secrets. For more information, see JSON structure of Secrets Manager secrets .

You can specify MasterSecretArn or SuperuserSecretArn but not both. They represent the same superuser secret.

Returns:

this

superuserSecretKmsKeyArn

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder superuserSecretKmsKeyArn(String superuserSecretKmsKeyArn)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getSuperuserSecretKmsKeyArn()

Parameters:

superuserSecretKmsKeyArn - The ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if you use the alternating users strategy and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key aws/secretsmanager . CloudFormation grants the execution role for the Lambda rotation function Decrypt , DescribeKey , and GenerateDataKey permission to the key in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager . You can specify MasterSecretKmsKeyArn or SuperuserSecretKmsKeyArn but not both. They represent the same superuser secret KMS key .

Returns:

this

vpcSecurityGroupIds

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder vpcSecurityGroupIds(String vpcSecurityGroupIds)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getVpcSecurityGroupIds()

Parameters:

vpcSecurityGroupIds - A comma-separated list of security group IDs applied to the target database. The template applies the same security groups as on the Lambda rotation function that is created as part of this stack.

Returns:

this

vpcSubnetIds

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.Builder vpcSubnetIds(String vpcSubnetIds)

Sets the value of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty.getVpcSubnetIds()

Parameters:

vpcSubnetIds - A comma separated list of VPC subnet IDs of the target database network. The Lambda rotation function is in the same subnet group.

Returns:

this

build

@Stability(Stable)
public CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty>

Returns:

a new instance of CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty

Throws:

NullPointerException - if any required attribute was not provided