Class CfnDBClusterProps.Jsii$Proxy
- All Implemented Interfaces:
CfnDBClusterProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- CfnDBClusterProps
CfnDBClusterProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.docdb.CfnDBClusterProps
CfnDBClusterProps.Builder, CfnDBClusterProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnDBClusterProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnDBClusterProps.Builder.protectedJsii$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.JsonNodefinal booleanA list of Amazon EC2 Availability Zones that instances in the cluster can be created in.final NumberThe number of days for which automated backups are retained.final ObjectAWS::DocDB::DBCluster.CopyTagsToSnapshot.final StringThe cluster identifier.final StringThe name of the cluster parameter group to associate with this cluster.final StringA subnet group to associate with this cluster.final ObjectProtects clusters from being accidentally deleted.The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.final StringThe version number of the database engine to use.final StringThe AWS KMS key identifier for an encrypted cluster.final StringThe name of the master user for the cluster.final StringThe password for the master database user.final NumbergetPort()Specifies the port that the database engine is listening on.final StringThe daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriodparameter.final StringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).final StringAWS::DocDB::DBCluster.RestoreToTime.final StringAWS::DocDB::DBCluster.RestoreType.final StringThe identifier for the snapshot or cluster snapshot to restore from.final StringAWS::DocDB::DBCluster.SourceDBClusterIdentifier.final ObjectSpecifies whether the cluster is encrypted.getTags()The tags to be assigned to the cluster.final ObjectAWS::DocDB::DBCluster.UseLatestRestorableTime.A list of EC2 VPC security groups to associate with this cluster.final inthashCode()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 theCfnDBClusterProps.Builder.
-
-
Method Details
-
getAvailabilityZones
Description copied from interface:CfnDBClusterPropsA list of Amazon EC2 Availability Zones that instances in the cluster can be created in.- Specified by:
getAvailabilityZonesin interfaceCfnDBClusterProps
-
getBackupRetentionPeriod
Description copied from interface:CfnDBClusterPropsThe number of days for which automated backups are retained. You must specify a minimum value of 1.Default: 1
Constraints:
- Must be a value from 1 to 35.
- Specified by:
getBackupRetentionPeriodin interfaceCfnDBClusterProps
-
getCopyTagsToSnapshot
Description copied from interface:CfnDBClusterPropsAWS::DocDB::DBCluster.CopyTagsToSnapshot.- Specified by:
getCopyTagsToSnapshotin interfaceCfnDBClusterProps
-
getDbClusterIdentifier
Description copied from interface:CfnDBClusterPropsThe cluster identifier. This parameter is stored as a lowercase 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- Specified by:
getDbClusterIdentifierin interfaceCfnDBClusterProps
-
getDbClusterParameterGroupName
Description copied from interface:CfnDBClusterPropsThe name of the cluster parameter group to associate with this cluster.- Specified by:
getDbClusterParameterGroupNamein interfaceCfnDBClusterProps
-
getDbSubnetGroupName
Description copied from interface:CfnDBClusterPropsA subnet group to associate with this cluster.Constraints: Must match the name of an existing
DBSubnetGroup. Must not be default.Example:
mySubnetgroup- Specified by:
getDbSubnetGroupNamein interfaceCfnDBClusterProps
-
getDeletionProtection
Description copied from interface:CfnDBClusterPropsProtects clusters from being accidentally deleted.If enabled, the cluster cannot be deleted unless it is modified and
DeletionProtectionis disabled.- Specified by:
getDeletionProtectionin interfaceCfnDBClusterProps
-
getEnableCloudwatchLogsExports
Description copied from interface:CfnDBClusterPropsThe list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
- Specified by:
getEnableCloudwatchLogsExportsin interfaceCfnDBClusterProps
-
getEngineVersion
Description copied from interface:CfnDBClusterPropsThe version number of the database engine to use.The
--engine-versionwill default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.- Specified by:
getEngineVersionin interfaceCfnDBClusterProps
-
getKmsKeyId
Description copied from interface:CfnDBClusterPropsThe AWS KMS key identifier for an encrypted cluster.The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If an encryption key is not specified in
KmsKeyId:- If the
StorageEncryptedparameter istrue, Amazon DocumentDB uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .
- Specified by:
getKmsKeyIdin interfaceCfnDBClusterProps
- If the
-
getMasterUsername
Description copied from interface:CfnDBClusterPropsThe name of the master user for the cluster.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.
- Specified by:
getMasterUsernamein interfaceCfnDBClusterProps
-
getMasterUserPassword
Description copied from interface:CfnDBClusterPropsThe password for the master database user.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.
- Specified by:
getMasterUserPasswordin interfaceCfnDBClusterProps
-
getPort
Description copied from interface:CfnDBClusterPropsSpecifies the port that the database engine is listening on.- Specified by:
getPortin interfaceCfnDBClusterProps
-
getPreferredBackupWindow
Description copied from interface:CfnDBClusterPropsThe daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriodparameter.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.
- Specified by:
getPreferredBackupWindowin interfaceCfnDBClusterProps
- Must be in the format
-
getPreferredMaintenanceWindow
Description copied from interface:CfnDBClusterPropsThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
- Specified by:
getPreferredMaintenanceWindowin interfaceCfnDBClusterProps
-
getRestoreToTime
Description copied from interface:CfnDBClusterPropsAWS::DocDB::DBCluster.RestoreToTime.- Specified by:
getRestoreToTimein interfaceCfnDBClusterProps
-
getRestoreType
Description copied from interface:CfnDBClusterPropsAWS::DocDB::DBCluster.RestoreType.- Specified by:
getRestoreTypein interfaceCfnDBClusterProps
-
getSnapshotIdentifier
Description copied from interface:CfnDBClusterPropsThe identifier for the snapshot or cluster snapshot to restore from.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.
- Specified by:
getSnapshotIdentifierin interfaceCfnDBClusterProps
-
getSourceDbClusterIdentifier
Description copied from interface:CfnDBClusterPropsAWS::DocDB::DBCluster.SourceDBClusterIdentifier.- Specified by:
getSourceDbClusterIdentifierin interfaceCfnDBClusterProps
-
getStorageEncrypted
Description copied from interface:CfnDBClusterPropsSpecifies whether the cluster is encrypted.- Specified by:
getStorageEncryptedin interfaceCfnDBClusterProps
-
getTags
Description copied from interface:CfnDBClusterPropsThe tags to be assigned to the cluster.- Specified by:
getTagsin interfaceCfnDBClusterProps
-
getUseLatestRestorableTime
Description copied from interface:CfnDBClusterPropsAWS::DocDB::DBCluster.UseLatestRestorableTime.- Specified by:
getUseLatestRestorableTimein interfaceCfnDBClusterProps
-
getVpcSecurityGroupIds
Description copied from interface:CfnDBClusterPropsA list of EC2 VPC security groups to associate with this cluster.- Specified by:
getVpcSecurityGroupIdsin interfaceCfnDBClusterProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-