@Stability(value=Stable) @Internal public static final class CfnDBClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnDBClusterProps
CfnDBClusterPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnDBClusterProps.Builder, CfnDBClusterProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnDBClusterProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnDBClusterProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Object |
getAssociatedRoles()
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
List<String> |
getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Number |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Number |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
Object |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
String |
getDatabaseName()
The name of your database.
|
String |
getDbClusterIdentifier()
The DB cluster identifier.
|
String |
getDbClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDbSubnetGroupName()
A DB subnet group that you want to associate with this DB cluster.
|
Object |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Object |
getEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Object |
getEnableIamDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
|
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getGlobalClusterIdentifier()
If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
|
String |
getKmsKeyId()
The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
|
String |
getMasterUsername()
The name of the master user for the DB cluster.
|
String |
getMasterUserPassword()
The master password for the DB instance.
|
Number |
getPort()
The port number on which the DB instances in the DB cluster accept connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created.
|
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getReplicationSourceIdentifier()
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
String |
getRestoreType()
The type of restore to be performed.
|
Object |
getScalingConfiguration()
The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
|
String |
getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
String |
getSourceDbClusterIdentifier()
When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
|
String |
getSourceRegion()
The AWS Region which contains the source DB cluster when replicating a DB cluster.
|
Object |
getStorageEncrypted()
Indicates whether the DB cluster is encrypted.
|
List<CfnTag> |
getTags()
Tags to assign to the DB cluster.
|
Object |
getUseLatestRestorableTime()
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnDBClusterProps.Builder builder)
CfnDBClusterProps.Builder.public final String getEngine()
CfnDBClusterProps
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
getEngine in interface CfnDBClusterPropspublic final Object getAssociatedRoles()
CfnDBClusterPropsIAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
getAssociatedRoles in interface CfnDBClusterPropspublic final List<String> getAvailabilityZones()
CfnDBClusterPropsFor information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
getAvailabilityZones in interface CfnDBClusterPropspublic final Number getBacktrackWindow()
CfnDBClusterProps
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
getBacktrackWindow in interface CfnDBClusterPropspublic final Number getBackupRetentionPeriod()
CfnDBClusterPropsDefault: 1
Constraints:
getBackupRetentionPeriod in interface CfnDBClusterPropspublic final Object getCopyTagsToSnapshot()
CfnDBClusterPropsThe default is not to copy them.
getCopyTagsToSnapshot in interface CfnDBClusterPropspublic final String getDatabaseName()
CfnDBClusterPropsIf you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
getDatabaseName in interface CfnDBClusterPropspublic final String getDbClusterIdentifier()
CfnDBClusterPropsConstraints:
Example: my-cluster1
getDbClusterIdentifier in interface CfnDBClusterPropspublic final String getDbClusterParameterGroupName()
CfnDBClusterProps
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
getDbClusterParameterGroupName in interface CfnDBClusterPropspublic final String getDbSubnetGroupName()
CfnDBClusterProps
If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
getDbSubnetGroupName in interface CfnDBClusterPropspublic final Object getDeletionProtection()
CfnDBClusterPropsThe database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
getDeletionProtection in interface CfnDBClusterPropspublic final List<String> getEnableCloudwatchLogsExports()
CfnDBClusterPropsThe values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Aurora MySQL
Valid values: audit , error , general , slowquery
Aurora PostgreSQL
Valid values: postgresql
getEnableCloudwatchLogsExports in interface CfnDBClusterPropspublic final Object getEnableHttpEndpoint()
CfnDBClusterPropsBy default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
getEnableHttpEndpoint in interface CfnDBClusterPropspublic final Object getEnableIamDatabaseAuthentication()
CfnDBClusterPropsBy default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
getEnableIamDatabaseAuthentication in interface CfnDBClusterPropspublic final String getEngineMode()
CfnDBClusterProps
The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
getEngineMode in interface CfnDBClusterPropspublic final String getEngineVersion()
CfnDBClusterProps
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql , use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
getEngineVersion in interface CfnDBClusterPropspublic final String getGlobalClusterIdentifier()
CfnDBClusterPropsTo define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren't configuring a global database cluster, don't specify this property.
To remove the DB cluster from a global database cluster, specify an empty value for the
GlobalClusterIdentifierproperty.
For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
getGlobalClusterIdentifier in interface CfnDBClusterPropspublic final String getKmsKeyId()
CfnDBClusterProps
If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .
If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
getKmsKeyId in interface CfnDBClusterPropspublic final String getMasterUsername()
CfnDBClusterProps
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
getMasterUsername in interface CfnDBClusterPropspublic final String getMasterUserPassword()
CfnDBClusterProps
If you specify the
SourceDBClusterIdentifier,SnapshotIdentifier, orGlobalClusterIdentifierproperty, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
getMasterUserPassword in interface CfnDBClusterPropspublic final Number getPort()
CfnDBClusterPropsDefault:
EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)EngineMode is serverless :3306 when Engine is aurora or aurora-mysql5432 when Engine is aurora-postgresql
The
No interruptionon update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
getPort in interface CfnDBClusterPropspublic final String getPreferredBackupWindow()
CfnDBClusterPropsFor more information, see Backup Window in the Amazon Aurora User Guide.
Constraints:
hh24:mi-hh24:mi .getPreferredBackupWindow in interface CfnDBClusterPropspublic final String getPreferredMaintenanceWindow()
CfnDBClusterProps
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
getPreferredMaintenanceWindow in interface CfnDBClusterPropspublic final String getReplicationSourceIdentifier()
CfnDBClusterPropsgetReplicationSourceIdentifier in interface CfnDBClusterPropspublic final String getRestoreType()
CfnDBClusterProps
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.
getRestoreType in interface CfnDBClusterPropspublic final Object getScalingConfiguration()
CfnDBClusterPropsCurrently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
getScalingConfiguration in interface CfnDBClusterPropspublic final String getSnapshotIdentifier()
CfnDBClusterPropsYou can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
GlobalClusterIdentifierMasterUsernameMasterUserPasswordReplicationSourceIdentifierRestoreTypeSourceDBClusterIdentifierSourceRegionStorageEncrypted (for an encrypted snapshot)UseLatestRestorableTimeConstraints:
getSnapshotIdentifier in interface CfnDBClusterPropspublic final String getSourceDbClusterIdentifier()
CfnDBClusterPropsConstraints:
getSourceDbClusterIdentifier in interface CfnDBClusterPropspublic final String getSourceRegion()
CfnDBClusterProps
For example, us-east-1 .
getSourceRegion in interface CfnDBClusterPropspublic final Object getStorageEncrypted()
CfnDBClusterProps
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
getStorageEncrypted in interface CfnDBClusterPropspublic final List<CfnTag> getTags()
CfnDBClusterPropsgetTags in interface CfnDBClusterPropspublic final Object getUseLatestRestorableTime()
CfnDBClusterPropsBy default, the DB cluster is not restored to the latest restorable backup time.
getUseLatestRestorableTime in interface CfnDBClusterPropspublic final List<String> getVpcSecurityGroupIds()
CfnDBClusterPropsIf you plan to update the resource, don't specify VPC security groups in a shared VPC.
getVpcSecurityGroupIds in interface CfnDBClusterProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.