Class CfnRotationSchedule.HostedRotationLambdaProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnRotationSchedule.HostedRotationLambdaProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnRotationSchedule.HostedRotationLambdaProperty
CfnRotationSchedule.HostedRotationLambdaProperty
-
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.CfnRotationSchedule.HostedRotationLambdaProperty
CfnRotationSchedule.HostedRotationLambdaProperty.Builder, CfnRotationSchedule.HostedRotationLambdaProperty.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnRotationSchedule.HostedRotationLambdaProperty.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
A string of the characters that you don't want in the password.final String
The ARN of the KMS key that Secrets Manager uses to encrypt the secret.final String
The ARN of the secret that contains superuser credentials, if you use the Alternating users rotation strategy .final String
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.final String
The name of the Lambda rotation function.final String
The rotation template to base the rotation function on, one of the following:.final String
By default, CloudFormation deploys Python 3.9 binaries for the rotation function.final String
The ARN of the secret that contains superuser credentials, if you use the Alternating users rotation strategy .final String
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.final String
A comma-separated list of security group IDs applied to the target database.final String
A comma separated list of VPC subnet IDs of the target database network.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theCfnRotationSchedule.HostedRotationLambdaProperty.Builder
.
-
-
Method Details
-
getRotationType
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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 SecretsManagerRDSPostgreSQLRotationSingleUserPostgreSQLMultiUser
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 .
- Specified by:
getRotationType
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getExcludeCharacters
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
A string of the characters that you don't want in the password.- Specified by:
getExcludeCharacters
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getKmsKeyArn
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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
. Ifaws/secretsmanager
doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.- Specified by:
getKmsKeyArn
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getMasterSecretArn
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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 functionGetSecretValue
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
orSuperuserSecretArn
but not both. They represent the same superuser secret.- Specified by:
getMasterSecretArn
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getMasterSecretKmsKeyArn
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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 keyaws/secretsmanager
. CloudFormation grants the execution role for the Lambda rotation functionDecrypt
,DescribeKey
, andGenerateDataKey
permission to the key in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager .You can specify
MasterSecretKmsKeyArn
orSuperuserSecretKmsKeyArn
but not both. They represent the same superuser secret KMS key .- Specified by:
getMasterSecretKmsKeyArn
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getRotationLambdaName
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
The name of the Lambda rotation function.- Specified by:
getRotationLambdaName
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getRuntime
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
By default, CloudFormation deploys Python 3.9 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.7, enter python3.7
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 .
- Specified by:
getRuntime
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getSuperuserSecretArn
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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 functionGetSecretValue
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
orSuperuserSecretArn
but not both. They represent the same superuser secret.- Specified by:
getSuperuserSecretArn
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getSuperuserSecretKmsKeyArn
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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 keyaws/secretsmanager
. CloudFormation grants the execution role for the Lambda rotation functionDecrypt
,DescribeKey
, andGenerateDataKey
permission to the key in this property. For more information, see Lambda rotation function execution role permissions for Secrets Manager .You can specify
MasterSecretKmsKeyArn
orSuperuserSecretKmsKeyArn
but not both. They represent the same superuser secret KMS key .- Specified by:
getSuperuserSecretKmsKeyArn
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getVpcSecurityGroupIds
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
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.
- Specified by:
getVpcSecurityGroupIds
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
getVpcSubnetIds
Description copied from interface:CfnRotationSchedule.HostedRotationLambdaProperty
A comma separated list of VPC subnet IDs of the target database network.The Lambda rotation function is in the same subnet group.
- Specified by:
getVpcSubnetIds
in interfaceCfnRotationSchedule.HostedRotationLambdaProperty
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-