CfnDBCluster L1 construct
The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster.
Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnDBCluster = new docdb.CfnDBCluster(this, 'MyCfnDBCluster', /* all optional props */ {
availabilityZones: ['availabilityZones'],
backupRetentionPeriod: 123,
copyTagsToSnapshot: false,
dbClusterIdentifier: 'dbClusterIdentifier',
dbClusterParameterGroupName: 'dbClusterParameterGroupName',
dbSubnetGroupName: 'dbSubnetGroupName',
deletionProtection: false,
enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
engineVersion: 'engineVersion',
globalClusterIdentifier: 'globalClusterIdentifier',
kmsKeyId: 'kmsKeyId',
manageMasterUserPassword: false,
masterUsername: 'masterUsername',
masterUserPassword: 'masterUserPassword',
masterUserSecretKmsKeyId: 'masterUserSecretKmsKeyId',
networkType: 'networkType',
port: 123,
preferredBackupWindow: 'preferredBackupWindow',
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
restoreToTime: 'restoreToTime',
restoreType: 'restoreType',
rotateMasterUserPassword: false,
serverlessV2ScalingConfiguration: {
maxCapacity: 123,
minCapacity: 123,
},
snapshotIdentifier: 'snapshotIdentifier',
sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
storageEncrypted: false,
storageType: 'storageType',
tags: [{
key: 'key',
value: 'value',
}],
useLatestRestorableTime: false,
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_docdb as docdb
cfn_db_cluster = docdb.CfnDBCluster(self, "MyCfnDBCluster",
availability_zones=["availabilityZones"],
backup_retention_period=123,
copy_tags_to_snapshot=False,
db_cluster_identifier="dbClusterIdentifier",
db_cluster_parameter_group_name="dbClusterParameterGroupName",
db_subnet_group_name="dbSubnetGroupName",
deletion_protection=False,
enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
engine_version="engineVersion",
global_cluster_identifier="globalClusterIdentifier",
kms_key_id="kmsKeyId",
manage_master_user_password=False,
master_username="masterUsername",
master_user_password="masterUserPassword",
master_user_secret_kms_key_id="masterUserSecretKmsKeyId",
network_type="networkType",
port=123,
preferred_backup_window="preferredBackupWindow",
preferred_maintenance_window="preferredMaintenanceWindow",
restore_to_time="restoreToTime",
restore_type="restoreType",
rotate_master_user_password=False,
serverless_v2_scaling_configuration=docdb.CfnDBCluster.ServerlessV2ScalingConfigurationProperty(
max_capacity=123,
min_capacity=123
),
snapshot_identifier="snapshotIdentifier",
source_db_cluster_identifier="sourceDbClusterIdentifier",
storage_encrypted=False,
storage_type="storageType",
tags=[CfnTag(
key="key",
value="value"
)],
use_latest_restorable_time=False,
vpc_security_group_ids=["vpcSecurityGroupIds"]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.docdb.*;
CfnDBCluster cfnDBCluster = CfnDBCluster.Builder.create(this, "MyCfnDBCluster")
.availabilityZones(List.of("availabilityZones"))
.backupRetentionPeriod(123)
.copyTagsToSnapshot(false)
.dbClusterIdentifier("dbClusterIdentifier")
.dbClusterParameterGroupName("dbClusterParameterGroupName")
.dbSubnetGroupName("dbSubnetGroupName")
.deletionProtection(false)
.enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
.engineVersion("engineVersion")
.globalClusterIdentifier("globalClusterIdentifier")
.kmsKeyId("kmsKeyId")
.manageMasterUserPassword(false)
.masterUsername("masterUsername")
.masterUserPassword("masterUserPassword")
.masterUserSecretKmsKeyId("masterUserSecretKmsKeyId")
.networkType("networkType")
.port(123)
.preferredBackupWindow("preferredBackupWindow")
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.restoreToTime("restoreToTime")
.restoreType("restoreType")
.rotateMasterUserPassword(false)
.serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationProperty.builder()
.maxCapacity(123)
.minCapacity(123)
.build())
.snapshotIdentifier("snapshotIdentifier")
.sourceDbClusterIdentifier("sourceDbClusterIdentifier")
.storageEncrypted(false)
.storageType("storageType")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.useLatestRestorableTime(false)
.vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DocDB;
var cfnDBCluster = new CfnDBCluster(this, "MyCfnDBCluster", new CfnDBClusterProps {
AvailabilityZones = new [] { "availabilityZones" },
BackupRetentionPeriod = 123,
CopyTagsToSnapshot = false,
DbClusterIdentifier = "dbClusterIdentifier",
DbClusterParameterGroupName = "dbClusterParameterGroupName",
DbSubnetGroupName = "dbSubnetGroupName",
DeletionProtection = false,
EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
EngineVersion = "engineVersion",
GlobalClusterIdentifier = "globalClusterIdentifier",
KmsKeyId = "kmsKeyId",
ManageMasterUserPassword = false,
MasterUsername = "masterUsername",
MasterUserPassword = "masterUserPassword",
MasterUserSecretKmsKeyId = "masterUserSecretKmsKeyId",
NetworkType = "networkType",
Port = 123,
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
RestoreToTime = "restoreToTime",
RestoreType = "restoreType",
RotateMasterUserPassword = false,
ServerlessV2ScalingConfiguration = new ServerlessV2ScalingConfigurationProperty {
MaxCapacity = 123,
MinCapacity = 123
},
SnapshotIdentifier = "snapshotIdentifier",
SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
StorageEncrypted = false,
StorageType = "storageType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UseLatestRestorableTime = false,
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDBCluster := awscdk.Aws_docdb.NewCfnDBCluster(this, jsii.String("MyCfnDBCluster"), &CfnDBClusterProps{
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
BackupRetentionPeriod: jsii.Number(123),
CopyTagsToSnapshot: jsii.Boolean(false),
DbClusterIdentifier: jsii.String("dbClusterIdentifier"),
DbClusterParameterGroupName: jsii.String("dbClusterParameterGroupName"),
DbSubnetGroupName: jsii.String("dbSubnetGroupName"),
DeletionProtection: jsii.Boolean(false),
EnableCloudwatchLogsExports: []*string{
jsii.String("enableCloudwatchLogsExports"),
},
EngineVersion: jsii.String("engineVersion"),
GlobalClusterIdentifier: jsii.String("globalClusterIdentifier"),
KmsKeyId: jsii.String("kmsKeyId"),
ManageMasterUserPassword: jsii.Boolean(false),
MasterUsername: jsii.String("masterUsername"),
MasterUserPassword: jsii.String("masterUserPassword"),
MasterUserSecretKmsKeyId: jsii.String("masterUserSecretKmsKeyId"),
NetworkType: jsii.String("networkType"),
Port: jsii.Number(123),
PreferredBackupWindow: jsii.String("preferredBackupWindow"),
PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
RestoreToTime: jsii.String("restoreToTime"),
RestoreType: jsii.String("restoreType"),
RotateMasterUserPassword: jsii.Boolean(false),
ServerlessV2ScalingConfiguration: &ServerlessV2ScalingConfigurationProperty{
MaxCapacity: jsii.Number(123),
MinCapacity: jsii.Number(123),
},
SnapshotIdentifier: jsii.String("snapshotIdentifier"),
SourceDbClusterIdentifier: jsii.String("sourceDbClusterIdentifier"),
StorageEncrypted: jsii.Boolean(false),
StorageType: jsii.String("storageType"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UseLatestRestorableTime: jsii.Boolean(false),
VpcSecurityGroupIds: []*string{
jsii.String("vpcSecurityGroupIds"),
},
})
Initializer
new CfnDBCluster(scope: Construct, id: string, props?: CfnDBClusterProps)
CfnDBCluster(scope: Construct, id: str, props: typing.Optional[CfnDBClusterProps] = None)
new CfnDBCluster(Construct scope, String id, CfnDBClusterProps props)
new CfnDBCluster(Construct scope, string id, CfnDBClusterProps? props = null)
NewCfnDBCluster(Scope Construct, Id *string, Props CfnDBClusterProps)
Construct Props
availabilityZonesoptionalstring[]availability_zonesoptionaltyping.List[str]availabilityZonesoptionalList<String>AvailabilityZonesoptionalstring[]AvailabilityZonesoptional*[]*string#backupRetentionPeriodoptionalnumberbackup_retention_periodoptionalint | floatbackupRetentionPeriodoptionalNumberBackupRetentionPeriodoptionaldoubleBackupRetentionPeriodoptional*float64#Default: 1
Constraints:
- Must be a value from 1 to 35.
copyTagsToSnapshotoptionalboolean | IResolvablecopy_tags_to_snapshotoptionaltyping.Union[bool, IResolvable]copyTagsToSnapshotoptionalBooleanCopyTagsToSnapshotoptionalboolCopyTagsToSnapshotoptionalinterface{}#The default is false .
dbClusterIdentifieroptionalstringdb_cluster_identifieroptionalstrdbClusterIdentifieroptionalStringDbClusterIdentifieroptionalstringDbClusterIdentifieroptional*string#Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
dbClusterParameterGroupNameoptionalstringdb_cluster_parameter_group_nameoptionalstrdbClusterParameterGroupNameoptionalStringDbClusterParameterGroupNameoptionalstringDbClusterParameterGroupNameoptional*string#dbSubnetGroupNameoptionalstringdb_subnet_group_nameoptionalstrdbSubnetGroupNameoptionalStringDbSubnetGroupNameoptionalstringDbSubnetGroupNameoptional*string#Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.
Example: mySubnetgroup
deletionProtectionoptionalboolean | IResolvabledeletion_protectionoptionaltyping.Union[bool, IResolvable]deletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptionalinterface{}#If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
enableCloudwatchLogsExportsoptionalstring[]enable_cloudwatch_logs_exportsoptionaltyping.List[str]enableCloudwatchLogsExportsoptionalList<String>EnableCloudwatchLogsExportsoptionalstring[]EnableCloudwatchLogsExportsoptional*[]*string#notes
You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#notes
The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
If you intend to trigger an in-place upgrade, please refer to Amazon DocumentDB in-place major version upgrade . Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.
globalClusterIdentifieroptionalstringglobal_cluster_identifieroptionalstrglobalClusterIdentifieroptionalStringGlobalClusterIdentifieroptionalstringGlobalClusterIdentifieroptional*string#kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#notes
The AWS key identifier is the Amazon Resource Name (ARN) for the AWS encryption key. If you are creating a cluster using the same AWS account that owns the AWS encryption key that is used to encrypt the new cluster, you can use the AWS key alias instead of the ARN for the AWS encryption key.
If an encryption key is not specified in KmsKeyId :
- If the
StorageEncryptedparameter istrue, Amazon DocumentDB uses your default encryption key.
AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .
manageMasterUserPasswordoptionalboolean | IResolvablemanage_master_user_passwordoptionaltyping.Union[bool, IResolvable]manageMasterUserPasswordoptionalBooleanManageMasterUserPasswordoptionalboolManageMasterUserPasswordoptionalinterface{}#Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
masterUsernameoptionalstringmaster_usernameoptionalstrmasterUsernameoptionalStringMasterUsernameoptionalstringMasterUsernameoptional*string#Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
masterUserPasswordoptionalstringmaster_user_passwordoptionalstrmasterUserPasswordoptionalStringMasterUserPasswordoptionalstringMasterUserPasswordoptional*string#This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
masterUserSecretKmsKeyIdoptionalstringmaster_user_secret_kms_key_idoptionalstrmasterUserSecretKmsKeyIdoptionalStringMasterUserSecretKmsKeyIdoptionalstringMasterUserSecretKmsKeyIdoptional*string#notes
This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#notes
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL ).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
preferredBackupWindowoptionalstringpreferred_backup_windowoptionalstrpreferredBackupWindowoptionalStringPreferredBackupWindowoptionalstringPreferredBackupWindowoptional*string#notes
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .
Constraints:
- Must be in the format
hh24:mi-hh24:mi. - Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string#notes
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
restoreToTimeoptionalstringrestore_to_timeoptionalstrrestoreToTimeoptionalStringRestoreToTimeoptionalstringRestoreToTimeoptional*string#notes
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
- Must be before the latest restorable time for the instance.
- Must be specified if the
UseLatestRestorableTimeparameter is not provided. - Cannot be specified if the
UseLatestRestorableTimeparameter istrue. - Cannot be specified if the
RestoreTypeparameter iscopy-on-write.
Example: 2015-03-07T23:45:00Z
restoreTypeoptionalstringrestore_typeoptionalstrrestoreTypeoptionalStringRestoreTypeoptionalstringRestoreTypeoptional*string#notes
full-copy- The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
rotateMasterUserPasswordoptionalboolean | IResolvablerotate_master_user_passwordoptionaltyping.Union[bool, IResolvable]rotateMasterUserPasswordoptionalBooleanRotateMasterUserPasswordoptionalboolRotateMasterUserPasswordoptionalinterface{}#notes
This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.
Constraint: You must apply the change immediately when rotating the master user password.
serverlessV2ScalingConfigurationoptionalIResolvable | CfnDBCluster.ServerlessV2ScalingConfigurationPropertyserverless_v2_scaling_configurationoptionaltyping.Union[IResolvable, ServerlessV2ScalingConfigurationProperty]serverlessV2ScalingConfigurationoptionalIResolvableServerlessV2ScalingConfigurationoptionalIResolvableServerlessV2ScalingConfigurationoptionalinterface{}#snapshotIdentifieroptionalstringsnapshot_identifieroptionalstrsnapshotIdentifieroptionalStringSnapshotIdentifieroptionalstringSnapshotIdentifieroptional*string#You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
- Must match the identifier of an existing snapshot.
sourceDbClusterIdentifieroptionalstringsource_db_cluster_identifieroptionalstrsourceDbClusterIdentifieroptionalStringSourceDbClusterIdentifieroptionalstringSourceDbClusterIdentifieroptional*string#Constraints:
- Must match the identifier of an existing
DBCluster.
storageEncryptedoptionalboolean | IResolvablestorage_encryptedoptionaltyping.Union[bool, IResolvable]storageEncryptedoptionalBooleanStorageEncryptedoptionalboolStorageEncryptedoptionalinterface{}#notes
If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.
storageTypeoptionalstringstorage_typeoptionalstrstorageTypeoptionalStringStorageTypeoptionalstringStorageTypeoptional*string#notes
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .
Valid values for storage type - standard | iopt1
Default value is standard
When you create an Amazon DocumentDB cluster with the storage type set to
iopt1, the storage type is returned in the response. The storage type isn't returned when you set it tostandard.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#useLatestRestorableTimeoptionalboolean | IResolvableuse_latest_restorable_timeoptionaltyping.Union[bool, IResolvable]useLatestRestorableTimeoptionalBooleanUseLatestRestorableTimeoptionalboolUseLatestRestorableTimeoptionalinterface{}#Default: false
Constraints: Cannot be specified if the RestoreToTime parameter is provided.
vpcSecurityGroupIdsoptionalstring[]vpc_security_group_idsoptionaltyping.List[str]vpcSecurityGroupIdsoptionalList<String>VpcSecurityGroupIdsoptionalstring[]VpcSecurityGroupIdsoptional*[]*string#Properties
attrClusterResourceIdstringattr_cluster_resource_idstrattrClusterResourceIdStringAttrClusterResourceIdstringAttrClusterResourceId*string#for example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
For example: 27017 .
attrReadEndpointstringattr_read_endpointstrattrReadEndpointStringAttrReadEndpointstringAttrReadEndpoint*string#For example: sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .
availabilityZonesmay be undefinedstring[]availability_zonesmay be undefinedtyping.List[str]availabilityZonesmay be undefinedList<String>AvailabilityZonesmay be undefinedstring[]AvailabilityZonesmay be undefined*[]*string#backupRetentionPeriodmay be undefinednumberbackup_retention_periodmay be undefinedint | floatbackupRetentionPeriodmay be undefinedNumberBackupRetentionPeriodmay be undefineddoubleBackupRetentionPeriodmay be undefined*float64#You must specify a minimum value of 1.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#copyTagsToSnapshotmay be undefinedboolean | IResolvablecopy_tags_to_snapshotmay be undefinedtyping.Union[bool, IResolvable]copyTagsToSnapshotmay be undefinedBooleanCopyTagsToSnapshotmay be undefinedboolCopyTagsToSnapshotmay be undefinedinterface{}#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#dbClusterIdentifiermay be undefinedstringdb_cluster_identifiermay be undefinedstrdbClusterIdentifiermay be undefinedStringDbClusterIdentifiermay be undefinedstringDbClusterIdentifiermay be undefined*string#This parameter is stored as a lowercase string.
dbClusterParameterGroupNamemay be undefinedstringdb_cluster_parameter_group_namemay be undefinedstrdbClusterParameterGroupNamemay be undefinedStringDbClusterParameterGroupNamemay be undefinedstringDbClusterParameterGroupNamemay be undefined*string#dbClusterRefDBClusterReferencedb_cluster_refDBClusterReferencedbClusterRefDBClusterReferenceDbClusterRefDBClusterReferenceDbClusterRefDBClusterReference#dbSubnetGroupNamemay be undefinedstringdb_subnet_group_namemay be undefinedstrdbSubnetGroupNamemay be undefinedStringDbSubnetGroupNamemay be undefinedstringDbSubnetGroupNamemay be undefined*string#deletionProtectionmay be undefinedboolean | IResolvabledeletion_protectionmay be undefinedtyping.Union[bool, IResolvable]deletionProtectionmay be undefinedBooleanDeletionProtectionmay be undefinedboolDeletionProtectionmay be undefinedinterface{}#enableCloudwatchLogsExportsmay be undefinedstring[]enable_cloudwatch_logs_exportsmay be undefinedtyping.List[str]enableCloudwatchLogsExportsmay be undefinedList<String>EnableCloudwatchLogsExportsmay be undefinedstring[]EnableCloudwatchLogsExportsmay be undefined*[]*string#engineVersionmay be undefinedstringengine_versionmay be undefinedstrengineVersionmay be undefinedStringEngineVersionmay be undefinedstringEngineVersionmay be undefined*string#globalClusterIdentifiermay be undefinedstringglobal_cluster_identifiermay be undefinedstrglobalClusterIdentifiermay be undefinedStringGlobalClusterIdentifiermay be undefinedstringGlobalClusterIdentifiermay be undefined*string#kmsKeyIdmay be undefinedstringkms_key_idmay be undefinedstrkmsKeyIdmay be undefinedStringKmsKeyIdmay be undefinedstringKmsKeyIdmay be undefined*string#The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
manageMasterUserPasswordmay be undefinedboolean | IResolvablemanage_master_user_passwordmay be undefinedtyping.Union[bool, IResolvable]manageMasterUserPasswordmay be undefinedBooleanManageMasterUserPasswordmay be undefinedboolManageMasterUserPasswordmay be undefinedinterface{}#masterUsernamemay be undefinedstringmaster_usernamemay be undefinedstrmasterUsernamemay be undefinedStringMasterUsernamemay be undefinedstringMasterUsernamemay be undefined*string#masterUserPasswordmay be undefinedstringmaster_user_passwordmay be undefinedstrmasterUserPasswordmay be undefinedStringMasterUserPasswordmay be undefinedstringMasterUserPasswordmay be undefined*string#masterUserSecretKmsKeyIdmay be undefinedstringmaster_user_secret_kms_key_idmay be undefinedstrmasterUserSecretKmsKeyIdmay be undefinedStringMasterUserSecretKmsKeyIdmay be undefinedstringMasterUserSecretKmsKeyIdmay be undefined*string#networkTypemay be undefinedstringnetwork_typemay be undefinedstrnetworkTypemay be undefinedStringNetworkTypemay be undefinedstringNetworkTypemay be undefined*string#portmay be undefinednumberportmay be undefinedint | floatportmay be undefinedNumberPortmay be undefineddoublePortmay be undefined*float64#preferredBackupWindowmay be undefinedstringpreferred_backup_windowmay be undefinedstrpreferredBackupWindowmay be undefinedStringPreferredBackupWindowmay be undefinedstringPreferredBackupWindowmay be undefined*string#preferredMaintenanceWindowmay be undefinedstringpreferred_maintenance_windowmay be undefinedstrpreferredMaintenanceWindowmay be undefinedStringPreferredMaintenanceWindowmay be undefinedstringPreferredMaintenanceWindowmay be undefined*string#If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
restoreToTimemay be undefinedstringrestore_to_timemay be undefinedstrrestoreToTimemay be undefinedStringRestoreToTimemay be undefinedstringRestoreToTimemay be undefined*string#restoreTypemay be undefinedstringrestore_typemay be undefinedstrrestoreTypemay be undefinedStringRestoreTypemay be undefinedstringRestoreTypemay be undefined*string#You can specify one of the following values:.
rotateMasterUserPasswordmay be undefinedboolean | IResolvablerotate_master_user_passwordmay be undefinedtyping.Union[bool, IResolvable]rotateMasterUserPasswordmay be undefinedBooleanRotateMasterUserPasswordmay be undefinedboolRotateMasterUserPasswordmay be undefinedinterface{}#serverlessV2ScalingConfigurationmay be undefinedIResolvable | CfnDBCluster.ServerlessV2ScalingConfigurationPropertyserverless_v2_scaling_configurationmay be undefinedtyping.Union[IResolvable, ServerlessV2ScalingConfigurationProperty]serverlessV2ScalingConfigurationmay be undefinedIResolvableServerlessV2ScalingConfigurationmay be undefinedIResolvableServerlessV2ScalingConfigurationmay be undefinedinterface{}#snapshotIdentifiermay be undefinedstringsnapshot_identifiermay be undefinedstrsnapshotIdentifiermay be undefinedStringSnapshotIdentifiermay be undefinedstringSnapshotIdentifiermay be undefined*string#sourceDbClusterIdentifiermay be undefinedstringsource_db_cluster_identifiermay be undefinedstrsourceDbClusterIdentifiermay be undefinedStringSourceDbClusterIdentifiermay be undefinedstringSourceDbClusterIdentifiermay be undefined*string#CfnElements must be defined within a stack scope (directly or indirectly).
storageEncryptedmay be undefinedboolean | IResolvablestorage_encryptedmay be undefinedtyping.Union[bool, IResolvable]storageEncryptedmay be undefinedBooleanStorageEncryptedmay be undefinedboolStorageEncryptedmay be undefinedinterface{}#storageTypemay be undefinedstringstorage_typemay be undefinedstrstorageTypemay be undefinedStringStorageTypemay be undefinedstringStorageTypemay be undefined*string#tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#useLatestRestorableTimemay be undefinedboolean | IResolvableuse_latest_restorable_timemay be undefinedtyping.Union[bool, IResolvable]useLatestRestorableTimemay be undefinedBooleanUseLatestRestorableTimemay be undefinedboolUseLatestRestorableTimemay be undefinedinterface{}#vpcSecurityGroupIdsmay be undefinedstring[]vpc_security_group_idsmay be undefinedtyping.List[str]vpcSecurityGroupIdsmay be undefinedList<String>VpcSecurityGroupIdsmay be undefinedstring[]VpcSecurityGroupIdsmay be undefined*[]*string#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnDBCluster(x: any): boolean@staticmethod def is_cfn_db_cluster(x: Any) -> boolpublic static Boolean isCfnDBCluster(Object x)public static bool IsCfnDBCluster(object x)func IsCfnDBCluster(X interface{}) *boolstatic#isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.