java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.CfnDBClusterProps.Jsii$Proxy

All Implemented Interfaces:: CfnDBClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: CfnDBClusterProps

@Stability(Stable) @Internal public static final class CfnDBClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnDBClusterProps

An implementation for CfnDBClusterProps

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.rds.CfnDBClusterProps
CfnDBClusterProps.Builder, CfnDBClusterProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

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.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final Number

getAllocatedStorage()

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

final Object

getAssociatedRoles()

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

final Object

getAutoMinorVersionUpgrade()

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

final List<String>

getAvailabilityZones()

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

final Number

getBacktrackWindow()

The target backtrack window, in seconds.

final Number

getBackupRetentionPeriod()

The number of days for which automated backups are retained.

final Object

getCopyTagsToSnapshot()

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

final String

getDatabaseName()

The name of your database.

final String

getDbClusterIdentifier()

The DB cluster identifier.

final String

getDbClusterInstanceClass()

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge .

final String

getDbClusterParameterGroupName()

The name of the DB cluster parameter group to associate with this DB cluster.

final String

getDbInstanceParameterGroupName()

The name of the DB parameter group to apply to all instances of the DB cluster.

final String

getDbSubnetGroupName()

A DB subnet group that you want to associate with this DB cluster.

final String

getDbSystemId()

Reserved for future use.

final Object

getDeletionProtection()

A value that indicates whether the DB cluster has deletion protection enabled.

final String

getDomain()

Indicates the directory ID of the Active Directory to create the DB cluster.

final String

getDomainIamRoleName()

Specifies the name of the IAM role to use when making API calls to the Directory Service.

final List<String>

getEnableCloudwatchLogsExports()

The list of log types that need to be enabled for exporting to CloudWatch Logs.

final Object

getEnableGlobalWriteForwarding()

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

final Object

getEnableHttpEndpoint()

Specifies whether to enable the HTTP endpoint for the DB cluster.

final Object

getEnableIamDatabaseAuthentication()

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

final Object

getEnableLocalWriteForwarding()

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

final String

getEngine()

The name of the database engine to be used for this DB cluster.

final String

getEngineLifecycleSupport()

The life cycle type for this DB cluster.

final String

getEngineMode()

The DB engine mode of the DB cluster, either provisioned or serverless .

final String

getEngineVersion()

The version number of the database engine to use.

final 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.

final Number

getIops()

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

final 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 .

final Object

getManageMasterUserPassword()

Specifies whether to manage the master user password with AWS Secrets Manager.

final String

getMasterUsername()

The name of the master user for the DB cluster.

final String

getMasterUserPassword()

The master password for the DB instance.

final Object

getMasterUserSecret()

The secret managed by RDS in AWS Secrets Manager for the master user password.

final Number

getMonitoringInterval()

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

final String

getMonitoringRoleArn()

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

final String

getNetworkType()

The network type of the DB cluster.

final Object

getPerformanceInsightsEnabled()

Specifies whether to turn on Performance Insights for the DB cluster.

final String

getPerformanceInsightsKmsKeyId()

The AWS KMS key identifier for encryption of Performance Insights data.

final Number

getPerformanceInsightsRetentionPeriod()

The number of days to retain Performance Insights data.

final Number

getPort()

The port number on which the DB instances in the DB cluster accept connections.

final String

getPreferredBackupWindow()

The daily time range during which automated backups are created.

final String

getPreferredMaintenanceWindow()

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

final Object

getPubliclyAccessible()

Specifies whether the DB cluster is publicly accessible.

final 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.

final String

getRestoreToTime()

The date and time to restore the DB cluster to.

final String

getRestoreType()

The type of restore to be performed.

final Object

getScalingConfiguration()

The scaling configuration of an Aurora Serverless v1 DB cluster.

final Object

getServerlessV2ScalingConfiguration()

The scaling configuration of an Aurora Serverless V2 DB cluster.

final String

getSnapshotIdentifier()

The identifier for the DB snapshot or DB cluster snapshot to restore from.

final String

getSourceDbClusterIdentifier()

When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

final String

getSourceRegion()

The AWS Region which contains the source DB cluster when replicating a DB cluster.

final Object

getStorageEncrypted()

Indicates whether the DB cluster is encrypted.

final String

getStorageType()

The storage type to associate with the DB cluster.

final List<CfnTag>

getTags()

Tags to assign to the DB cluster.

final Object

getUseLatestRestorableTime()

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

final List<String>

getVpcSecurityGroupIds()

A list of EC2 VPC security groups to associate with this DB cluster.

final int

hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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
  
  protected Jsii$Proxy(CfnDBClusterProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the CfnDBClusterProps.Builder.
Method Details
- getAllocatedStorage
  
  public final Number getAllocatedStorage()
  
  Description copied from interface: CfnDBClusterProps
  
  The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  This setting is required to create a Multi-AZ DB cluster.
  Specified by:
  
  getAllocatedStorage in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage
- getAssociatedRoles
  
  public final Object getAssociatedRoles()
  
  Description copied from interface: CfnDBClusterProps
  
  Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
  IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getAssociatedRoles in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles
- getAutoMinorVersionUpgrade
  
  public final Object getAutoMinorVersionUpgrade()
  
  Description copied from interface: CfnDBClusterProps
  
  Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
  By default, minor engine upgrades are applied automatically.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Specified by:
  
  getAutoMinorVersionUpgrade in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade
- getAvailabilityZones
  
  public final List<String> getAvailabilityZones()
  
  Description copied from interface: CfnDBClusterProps
  
  A list of Availability Zones (AZs) where instances in the DB cluster can be created.
  For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
  Valid for: Aurora DB clusters only
  Specified by:
  
  getAvailabilityZones in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones
- getBacktrackWindow
  
  public final Number getBacktrackWindow()
  
  Description copied from interface: CfnDBClusterProps
  The target backtrack window, in seconds. To disable backtracking, set this value to 0 .
  Valid for Cluster Type: Aurora MySQL DB clusters only
  Default: 0
  Constraints:
  
  If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  Specified by:
  
  getBacktrackWindow in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
- getBackupRetentionPeriod
  
  public final Number getBackupRetentionPeriod()
  
  Description copied from interface: CfnDBClusterProps
  The number of days for which automated backups are retained.
  Default: 1
  Constraints:
  
  Must be a value from 1 to 35
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Default: - 1
  Specified by:
  
  getBackupRetentionPeriod in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod
- getCopyTagsToSnapshot
  
  public final Object getCopyTagsToSnapshot()
  
  Description copied from interface: CfnDBClusterProps
  
  A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
  The default is not to copy them.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getCopyTagsToSnapshot in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot
- getDatabaseName
  
  public final String getDatabaseName()
  
  Description copied from interface: CfnDBClusterProps
  
  The name of your database.
  If 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 .
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getDatabaseName in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename
- getDbClusterIdentifier
  
  public final String getDbClusterIdentifier()
  
  Description copied from interface: CfnDBClusterProps
  The DB cluster identifier. This parameter is stored as a lowercase string.
  Constraints:
  
  Must contain from 1 to 63 letters, numbers, or hyphens.
  
  First character must be a letter.
  
  Can't end with a hyphen or contain two consecutive hyphens.
  
  Example: my-cluster1
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getDbClusterIdentifier in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier
- getDbClusterInstanceClass
  
  public final String getDbClusterInstanceClass()
  
  Description copied from interface: CfnDBClusterProps
  
  The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.
  For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .
  This setting is required to create a Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Specified by:
  
  getDbClusterInstanceClass in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass
- getDbClusterParameterGroupName
  
  public final String getDbClusterParameterGroupName()
  
  Description copied from interface: CfnDBClusterProps
  
  The name of the DB cluster parameter group to associate with this DB cluster.
  
  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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getDbClusterParameterGroupName in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname
- getDbInstanceParameterGroupName
  
  public final String getDbInstanceParameterGroupName()
  
  Description copied from interface: CfnDBClusterProps
  The name of the DB parameter group to apply to all instances of the DB cluster.
  
  When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
  
  Valid for Cluster Type: Aurora DB clusters only
  Default: The existing name setting
  Constraints:
  
  The DB parameter group must be in the same DB parameter group family as this DB cluster.
  
  The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
  Specified by:
  
  getDbInstanceParameterGroupName in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname
- getDbSubnetGroupName
  
  public final String getDbSubnetGroupName()
  
  Description copied from interface: CfnDBClusterProps
  
  A DB subnet group that you want to associate with this DB cluster.
  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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getDbSubnetGroupName in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname
- getDbSystemId
  
  public final String getDbSystemId()
  
  Description copied from interface: CfnDBClusterProps
  
  Reserved for future use.
  Specified by:
  
  getDbSystemId in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid
- getDeletionProtection
  
  public final Object getDeletionProtection()
  
  Description copied from interface: CfnDBClusterProps
  
  A value that indicates whether the DB cluster has deletion protection enabled.
  The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getDeletionProtection in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection
- getDomain
  
  public final String getDomain()
  
  Description copied from interface: CfnDBClusterProps
  
  Indicates the directory ID of the Active Directory to create the DB cluster.
  For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
  For more information, see Kerberos authentication in the Amazon Aurora User Guide .
  Valid for: Aurora DB clusters only
  Specified by:
  
  getDomain in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain
- getDomainIamRoleName
  
  public final String getDomainIamRoleName()
  
  Description copied from interface: CfnDBClusterProps
  
  Specifies the name of the IAM role to use when making API calls to the Directory Service.
  Valid for: Aurora DB clusters only
  Specified by:
  
  getDomainIamRoleName in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename
- getEnableCloudwatchLogsExports
  
  public final List<String> getEnableCloudwatchLogsExports()
  
  Description copied from interface: CfnDBClusterProps
  
  The list of log types that need to be enabled for exporting to CloudWatch Logs.
  The 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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getEnableCloudwatchLogsExports in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports
- getEnableGlobalWriteForwarding
  
  public final Object getEnableGlobalWriteForwarding()
  
  Description copied from interface: CfnDBClusterProps
  
  Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
  By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
  You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
  Valid for Cluster Type: Aurora DB clusters only
  Specified by:
  
  getEnableGlobalWriteForwarding in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding
- getEnableHttpEndpoint
  
  public final Object getEnableHttpEndpoint()
  
  Description copied from interface: CfnDBClusterProps
  Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
  When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
  RDS Data API is supported with the following DB clusters:
  
  Aurora PostgreSQL Serverless v2 and provisioned
  
  Aurora PostgreSQL and Aurora MySQL Serverless v1
  
  For more information, see Using RDS Data API in the Amazon Aurora User Guide .
  Valid for Cluster Type: Aurora DB clusters only
  Specified by:
  
  getEnableHttpEndpoint in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint
- getEnableIamDatabaseAuthentication
  
  public final Object getEnableIamDatabaseAuthentication()
  
  Description copied from interface: CfnDBClusterProps
  
  A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
  By default, mapping is disabled.
  For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
  Valid for: Aurora DB clusters only
  Specified by:
  
  getEnableIamDatabaseAuthentication in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication
- getEnableLocalWriteForwarding
  
  public final Object getEnableLocalWriteForwarding()
  
  Description copied from interface: CfnDBClusterProps
  
  Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
  By default, write operations aren't allowed on reader DB instances.
  Valid for: Aurora DB clusters only
  Specified by:
  
  getEnableLocalWriteForwarding in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding
- getEngine
  
  public final String getEngine()
  
  Description copied from interface: CfnDBClusterProps
  The name of the database engine to be used for this DB cluster.
  Valid Values:
  
  aurora-mysql
  
  aurora-postgresql
  
  mysql
  
  postgres
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getEngine in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine
- getEngineLifecycleSupport
  
  public final String getEngineLifecycleSupport()
  
  Description copied from interface: CfnDBClusterProps
  The life cycle type for this DB cluster.
  
  By default, this value is set to open-source-rds-extended-support , which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
  
  You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
  
  Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
  
  Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
  
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
  Default: open-source-rds-extended-support
  Specified by:
  
  getEngineLifecycleSupport in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginelifecyclesupport
- getEngineMode
  
  public final String getEngineMode()
  
  Description copied from interface: CfnDBClusterProps
  The DB engine mode of the DB cluster, either provisioned or serverless .
  The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
  For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :
  
  Limitations of Aurora Serverless v1
  
  Requirements for Aurora Serverless v2
  
  Valid for Cluster Type: Aurora DB clusters only
  Specified by:
  
  getEngineMode in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode
- getEngineVersion
  
  public final String getEngineVersion()
  
  Description copied from interface: CfnDBClusterProps
  
  The version number of the database engine to use.
  To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:
  aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
  You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
  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"
  To list all of the available engine versions for RDS for MySQL, use the following command:
  aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
  To list all of the available engine versions for RDS for PostgreSQL, use the following command:
  aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
  Aurora MySQL
  For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .
  Aurora PostgreSQL
  For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
  MySQL
  For information, see Amazon RDS for MySQL in the Amazon RDS User Guide .
  PostgreSQL
  For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getEngineVersion in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion
- getGlobalClusterIdentifier
  
  public final String getGlobalClusterIdentifier()
  
  Description copied from interface: CfnDBClusterProps
  
  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.
  To 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 GlobalClusterIdentifier property.
  
  For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
  Valid for: Aurora DB clusters only
  Specified by:
  
  getGlobalClusterIdentifier in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier
- getIops
  
  public final Number getIops()
  
  Description copied from interface: CfnDBClusterProps
  The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
  For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide .
  This setting is required to create a Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Constraints:
  
  Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
  Specified by:
  
  getIops in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops
- getKmsKeyId
  
  public final String getKmsKeyId()
  
  Description copied from interface: CfnDBClusterProps
  
  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 .
  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.
  If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getKmsKeyId in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid
- getManageMasterUserPassword
  
  public final Object getManageMasterUserPassword()
  
  Description copied from interface: CfnDBClusterProps
  Specifies whether to manage the master user password with AWS Secrets Manager.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Constraints:
  
  Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
  Specified by:
  
  getManageMasterUserPassword in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword
- getMasterUsername
  
  public final String getMasterUsername()
  
  Description copied from interface: CfnDBClusterProps
  
  The name of the master user for the DB cluster.
  
  If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, 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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getMasterUsername in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername
- getMasterUserPassword
  
  public final String getMasterUserPassword()
  
  Description copied from interface: CfnDBClusterProps
  
  The master password for the DB instance.
  
  If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, 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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getMasterUserPassword in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword
- getMasterUserSecret
  
  public final Object getMasterUserSecret()
  
  Description copied from interface: CfnDBClusterProps
  
  The secret managed by RDS in AWS Secrets Manager for the master user password.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Specified by:
  
  getMasterUserSecret in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret
- getMonitoringInterval
  
  public final Number getMonitoringInterval()
  
  Description copied from interface: CfnDBClusterProps
  
  The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
  To turn off collecting Enhanced Monitoring metrics, specify 0 .
  If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .
  Valid for Cluster Type: Multi-AZ DB clusters only
  Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
  Default: 0
  Specified by:
  
  getMonitoringInterval in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval
- getMonitoringRoleArn
  
  public final String getMonitoringRoleArn()
  
  Description copied from interface: CfnDBClusterProps
  
  The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .
  If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Specified by:
  
  getMonitoringRoleArn in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn
- getNetworkType
  
  public final String getNetworkType()
  
  Description copied from interface: CfnDBClusterProps
  The network type of the DB cluster.
  Valid values:
  
  IPV4
  
  DUAL
  
  The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ).
  For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
  Valid for: Aurora DB clusters only
  Specified by:
  
  getNetworkType in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype
- getPerformanceInsightsEnabled
  
  public final Object getPerformanceInsightsEnabled()
  
  Description copied from interface: CfnDBClusterProps
  
  Specifies whether to turn on Performance Insights for the DB cluster.
  For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
  Valid for Cluster Type: Multi-AZ DB clusters only
  Specified by:
  
  getPerformanceInsightsEnabled in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled
- getPerformanceInsightsKmsKeyId
  
  public final String getPerformanceInsightsKmsKeyId()
  
  Description copied from interface: CfnDBClusterProps
  
  The AWS KMS key identifier for encryption of Performance Insights data.
  The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .
  Valid for Cluster Type: Multi-AZ DB clusters only
  Specified by:
  
  getPerformanceInsightsKmsKeyId in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid
- getPerformanceInsightsRetentionPeriod
  
  public final Number getPerformanceInsightsRetentionPeriod()
  
  Description copied from interface: CfnDBClusterProps
  The number of days to retain Performance Insights data.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Valid Values:
  
  7
  
  month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  
  731
  
  Default: 7 days
  If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.
  Specified by:
  
  getPerformanceInsightsRetentionPeriod in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod
- getPort
  
  public final Number getPort()
  
  Description copied from interface: CfnDBClusterProps
  The port number on which the DB instances in the DB cluster accept connections.
  Default:
  
  When EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)
  
  When EngineMode is serverless :
  
  3306 when Engine is aurora or aurora-mysql
  
  5432 when Engine is aurora-postgresql
  
  The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getPort in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port
- getPreferredBackupWindow
  
  public final String getPreferredBackupWindow()
  
  Description copied from interface: CfnDBClusterProps
  The daily time range during which automated backups are created.
  For more information, see Backup Window in the Amazon Aurora User Guide.
  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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getPreferredBackupWindow in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow
- getPreferredMaintenanceWindow
  
  public final String getPreferredMaintenanceWindow()
  
  Description copied from interface: CfnDBClusterProps
  
  The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getPreferredMaintenanceWindow in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow
- getPubliclyAccessible
  
  public final Object getPubliclyAccessible()
  
  Description copied from interface: CfnDBClusterProps
  Specifies whether the DB cluster is publicly accessible.
  When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
  When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
  If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
  
  If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
  
  If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
  
  If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
  
  If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
  
  If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
  Specified by:
  
  getPubliclyAccessible in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible
- getReplicationSourceIdentifier
  
  public final String getReplicationSourceIdentifier()
  
  Description copied from interface: CfnDBClusterProps
  
  The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
  Valid for: Aurora DB clusters only
  Specified by:
  
  getReplicationSourceIdentifier in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier
- getRestoreToTime
  
  public final String getRestoreToTime()
  
  Description copied from interface: CfnDBClusterProps
  The date and time to restore the DB cluster to.
  Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
  Constraints:
  
  Must be before the latest restorable time for the DB instance
  
  Must be specified if UseLatestRestorableTime parameter isn't provided
  
  Can't be specified if the UseLatestRestorableTime parameter is enabled
  
  Can't be specified if the RestoreType parameter is copy-on-write
  
  This property must be used with SourceDBClusterIdentifier property. The resulting cluster will have the identifier that matches the value of the DBclusterIdentifier property.
  Example: 2015-03-07T23:45:00Z
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getRestoreToTime in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime
- getRestoreType
  
  public final String getRestoreType()
  
  Description copied from interface: CfnDBClusterProps
  The type of restore to be performed. You can specify one of the following values:.
  
  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.
  
  If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getRestoreType in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype
- getScalingConfiguration
  
  public final Object getScalingConfiguration()
  
  Description copied from interface: CfnDBClusterProps
  
  The scaling configuration of an Aurora Serverless v1 DB cluster.
  This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
  Valid for: Aurora Serverless v1 DB clusters only
  Specified by:
  
  getScalingConfiguration in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration
- getServerlessV2ScalingConfiguration
  
  public final Object getServerlessV2ScalingConfiguration()
  
  Description copied from interface: CfnDBClusterProps
  
  The scaling configuration of an Aurora Serverless V2 DB cluster.
  This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.
  Valid for: Aurora Serverless v2 DB clusters only
  Specified by:
  
  getServerlessV2ScalingConfiguration in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration
- getSnapshotIdentifier
  
  public final String getSnapshotIdentifier()
  
  Description copied from interface: CfnDBClusterProps
  The identifier for the DB snapshot or DB cluster snapshot to restore from.
  You 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:
  
  GlobalClusterIdentifier
  
  MasterUsername
  
  MasterUserPassword
  
  ReplicationSourceIdentifier
  
  RestoreType
  
  SourceDBClusterIdentifier
  
  SourceRegion
  
  StorageEncrypted (for an encrypted snapshot)
  
  UseLatestRestorableTime
  
  Constraints:
  
  Must match the identifier of an existing Snapshot.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getSnapshotIdentifier in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier
- getSourceDbClusterIdentifier
  
  public final String getSourceDbClusterIdentifier()
  
  Description copied from interface: CfnDBClusterProps
  When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
  Constraints:
  
  Must match the identifier of an existing DBCluster.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getSourceDbClusterIdentifier in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier
- getSourceRegion
  
  public final String getSourceRegion()
  
  Description copied from interface: CfnDBClusterProps
  
  The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .
  Valid for: Aurora DB clusters only
  Specified by:
  
  getSourceRegion in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion
- getStorageEncrypted
  
  public final Object getStorageEncrypted()
  
  Description copied from interface: CfnDBClusterProps
  
  Indicates whether the DB cluster is encrypted.
  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 .
  
  If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getStorageEncrypted in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted
- getStorageType
  
  public final String getStorageType()
  
  Description copied from interface: CfnDBClusterProps
  The storage type to associate with the DB cluster.
  For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .
  This setting is required to create a Multi-AZ DB cluster.
  When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values:
  
  Aurora DB clusters - aurora | aurora-iopt1
  
  Multi-AZ DB clusters - io1 | io2 | gp3
  
  Default:
  
  Aurora DB clusters - aurora
  
  Multi-AZ DB clusters - io1
  
  When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to aurora .
  Specified by:
  
  getStorageType in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype
- getTags
  
  public final List<CfnTag> getTags()
  
  Description copied from interface: CfnDBClusterProps
  
  Tags to assign to the DB cluster.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getTags in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
- getUseLatestRestorableTime
  
  public final Object getUseLatestRestorableTime()
  
  Description copied from interface: CfnDBClusterProps
  
  A value that indicates whether to restore the DB cluster to the latest restorable backup time.
  By default, the DB cluster is not restored to the latest restorable backup time.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getUseLatestRestorableTime in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime
- getVpcSecurityGroupIds
  
  public final List<String> getVpcSecurityGroupIds()
  
  Description copied from interface: CfnDBClusterProps
  
  A list of EC2 VPC security groups to associate with this DB cluster.
  If you plan to update the resource, don't specify VPC security groups in a shared VPC.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Specified by:
  
  getVpcSecurityGroupIds in interface CfnDBClusterProps
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class CfnDBClusterProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.CfnDBClusterProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getAllocatedStorage

getAssociatedRoles

getAutoMinorVersionUpgrade

getAvailabilityZones

getBacktrackWindow

getBackupRetentionPeriod

getCopyTagsToSnapshot

getDatabaseName

getDbClusterIdentifier

getDbClusterInstanceClass

getDbClusterParameterGroupName

getDbInstanceParameterGroupName

getDbSubnetGroupName

getDbSystemId

getDeletionProtection

getDomain

getDomainIamRoleName

getEnableCloudwatchLogsExports

getEnableGlobalWriteForwarding

getEnableHttpEndpoint

getEnableIamDatabaseAuthentication

getEnableLocalWriteForwarding

getEngine

getEngineLifecycleSupport

getEngineMode

getEngineVersion

getGlobalClusterIdentifier

getIops

getKmsKeyId

getManageMasterUserPassword

getMasterUsername

getMasterUserPassword

getMasterUserSecret

getMonitoringInterval

getMonitoringRoleArn

getNetworkType

getPerformanceInsightsEnabled

getPerformanceInsightsKmsKeyId

getPerformanceInsightsRetentionPeriod

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getPubliclyAccessible

getReplicationSourceIdentifier

getRestoreToTime

getRestoreType

getScalingConfiguration

getServerlessV2ScalingConfiguration

getSnapshotIdentifier

getSourceDbClusterIdentifier

getSourceRegion

getStorageEncrypted

getStorageType

getTags

getUseLatestRestorableTime

getVpcSecurityGroupIds

$jsii$toJson

equals

hashCode