software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule.HostedRotationLambdaProperty.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule.HostedRotationLambdaProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnRotationSchedule.HostedRotationLambdaProperty

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

A builder for CfnRotationSchedule.HostedRotationLambdaProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

rotationType

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder rotationType(String rotationType)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getRotationType()

Parameters:

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

• 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

excludeCharacters

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder excludeCharacters(String excludeCharacters)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getExcludeCharacters()

Parameters:

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

Returns:

this

kmsKeyArn

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnRotationSchedule.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(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder masterSecretArn(String masterSecretArn)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getMasterSecretArn()

Parameters:

masterSecretArn - The ARN of the secret that contains elevated credentials. You must create the elevated secret before you can set this property. The Lambda rotation function uses this secret for the Alternating users rotation strategy .

Returns:

this

masterSecretKmsKeyArn

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder masterSecretKmsKeyArn(String masterSecretKmsKeyArn)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getMasterSecretKmsKeyArn()

Parameters:

masterSecretKmsKeyArn - The ARN of the KMS key that Secrets Manager uses to encrypt the elevated secret if you use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) . If you don't specify this value and you use the alternating users strategy, 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

rotationLambdaName

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder rotationLambdaName(String rotationLambdaName)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getRotationLambdaName()

Parameters:

rotationLambdaName - The name of the Lambda rotation function.

Returns:

this

superuserSecretArn

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder superuserSecretArn(String superuserSecretArn)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getSuperuserSecretArn()

Parameters:

superuserSecretArn - The ARN of the secret that contains elevated credentials. You must create the superuser secret before you can set this property. The Lambda rotation function uses this secret for the Alternating users rotation strategy .

Returns:

this

superuserSecretKmsKeyArn

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder superuserSecretKmsKeyArn(String superuserSecretKmsKeyArn)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getSuperuserSecretKmsKeyArn()

Parameters:

superuserSecretKmsKeyArn - The ARN of the KMS key that Secrets Manager uses to encrypt the elevated secret if you use the [alternating users strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) . If you don't specify this value and you use the alternating users strategy, 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

vpcSecurityGroupIds

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder vpcSecurityGroupIds(String vpcSecurityGroupIds)

Sets the value of CfnRotationSchedule.HostedRotationLambdaProperty.getVpcSecurityGroupIds()

Parameters:

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

Returns:

this

vpcSubnetIds

@Stability(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty.Builder vpcSubnetIds(String vpcSubnetIds)

Sets the value of CfnRotationSchedule.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(value=Stable)
public CfnRotationSchedule.HostedRotationLambdaProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRotationSchedule.HostedRotationLambdaProperty

Throws:

NullPointerException - if any required attribute was not provided