Package software.amazon.awssdk.services.rds.model

Class CreateDbClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rds.model.RdsRequest
software.amazon.awssdk.services.rds.model.CreateDbClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDbClusterRequest extends RdsRequest implements ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

  • Method Details

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • availabilityZones

      public final List<String> availabilityZones()

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

      For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailabilityZones() method.

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

      For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

    • backupRetentionPeriod

      public final Integer backupRetentionPeriod()

      The number of days for which automated backups are retained.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

      Returns:
      The number of days for which automated backups are retained.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

    • characterSetName

      public final String characterSetName()

      The name of the character set (CharacterSet) to associate the DB cluster with.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      The name of the character set (CharacterSet) to associate the DB cluster with.

      Valid for Cluster Type: Aurora DB clusters only

    • databaseName

      public final String databaseName()

      The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The identifier for this DB cluster. This parameter is stored as a lowercase string.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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

      Returns:
      The identifier for this DB cluster. This parameter is stored as a lowercase string.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      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

    • dbClusterParameterGroupName

      public final String dbClusterParameterGroupName()

      The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • If supplied, must match the name of an existing DB cluster parameter group.

      Returns:
      The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • If supplied, must match the name of an existing DB cluster parameter group.

    • hasVpcSecurityGroupIds

      public final boolean hasVpcSecurityGroupIds()
      For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

      A DB subnet group to associate with this DB cluster.

      This setting is required to create a Multi-AZ DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must match the name of an existing DB subnet group.

      • Must not be default.

      Example: mydbsubnetgroup

      Returns:
      A DB subnet group to associate with this DB cluster.

      This setting is required to create a Multi-AZ DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must match the name of an existing DB subnet group.

      • Must not be default.

      Example: mydbsubnetgroup

    • engine

      public final String engine()

      The database engine to use for this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres

      Returns:
      The database engine to use for this DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres

    • engineVersion

      public final String engineVersion()

      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 (MySQL 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"

      For information about a specific engine, see the following topics:

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      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 (MySQL 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"

      For information about a specific engine, see the following topics:

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • port

      public final Integer port()

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: 1150-65535

      Default:

      • RDS for MySQL and Aurora MySQL - 3306

      • RDS for PostgreSQL and Aurora PostgreSQL - 5432

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: 1150-65535

      Default:

      • RDS for MySQL and Aurora MySQL - 3306

      • RDS for PostgreSQL and Aurora PostgreSQL - 5432

    • masterUsername

      public final String masterUsername()

      The name of the master user for the DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must be 1 to 16 letters or numbers.

      • First character must be a letter.

      • Can't be a reserved word for the chosen database engine.

      Returns:
      The name of the master user for the DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must be 1 to 16 letters or numbers.

      • First character must be a letter.

      • Can't be a reserved word for the chosen database engine.

    • masterUserPassword

      public final String masterUserPassword()

      The password for the master database user.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must contain from 8 to 41 characters.

      • Can contain any printable ASCII character except "/", """, or "@".

      • Can't be specified if ManageMasterUserPassword is turned on.

      Returns:
      The password for the master database user.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Constraints:

      • Must contain from 8 to 41 characters.

      • Can contain any printable ASCII character except "/", """, or "@".

      • Can't be specified if ManageMasterUserPassword is turned on.

    • optionGroupName

      public final String optionGroupName()

      The option group to associate the DB cluster with.

      DB clusters are associated with a default option group that can't be modified.

      Returns:
      The option group to associate the DB cluster with.

      DB clusters are associated with a default option group that can't be modified.

    • preferredBackupWindow

      public final String preferredBackupWindow()

      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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.

      Returns:
      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, 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.

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      The weekly time range during which system maintenance can occur.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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.

      Constraints:

      • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

      • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

      • Must be in Universal Coordinated Time (UTC).

      • Must be at least 30 minutes.

      Returns:
      The weekly time range during which system maintenance can occur.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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.

      Constraints:

      • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

      • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

      • Must be in Universal Coordinated Time (UTC).

      • Must be at least 30 minutes.

    • replicationSourceIdentifier

      public final String replicationSourceIdentifier()

      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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Tags to assign to the DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tags to assign to the DB cluster.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • storageEncrypted

      public final Boolean storageEncrypted()

      Specifies whether the DB cluster is encrypted.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      Specifies whether the DB cluster is encrypted.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key identifier for an encrypted 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.

      When a KMS key isn't specified in KmsKeyId:

      • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.

      • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS uses your default 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.

      If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      The Amazon Web Services KMS key identifier for an encrypted 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.

      When a KMS key isn't specified in KmsKeyId:

      • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.

      • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS uses your default 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.

      If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • preSignedUrl

      public final String preSignedUrl()

      When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

      The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

      The presigned URL request must contain the following parameter values:

      • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

      • DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.

      • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

      To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

      If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

      The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

      The presigned URL request must contain the following parameter values:

      • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

      • DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.

      • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

      To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

      If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

      Valid for Cluster Type: Aurora DB clusters only

    • enableIAMDatabaseAuthentication

      public final Boolean enableIAMDatabaseAuthentication()

      Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

    • backtrackWindow

      public final Long backtrackWindow()

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

      Returns:
      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).

    • hasEnableCloudwatchLogsExports

      public final boolean hasEnableCloudwatchLogsExports()
      For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enableCloudwatchLogsExports

      public final List<String> enableCloudwatchLogsExports()

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports() method.

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

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    • engineMode

      public final String engineMode()

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

      The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

      For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:

      Valid for Cluster Type: Aurora DB clusters only

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

      The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

      For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:

      Valid for Cluster Type: Aurora DB clusters only

    • scalingConfiguration

      public final ScalingConfiguration scalingConfiguration()

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for Cluster Type: Aurora DB clusters only

    • rdsCustomClusterConfiguration

      public final RdsCustomClusterConfiguration rdsCustomClusterConfiguration()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • deletionProtection

      public final Boolean deletionProtection()

      Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

      Valid for Cluster Type: Aurora DB clusters only

    • enableHttpEndpoint

      public final Boolean enableHttpEndpoint()

      Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By 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 v1 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 v1 in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By 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 v1 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 v1 in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

    • copyTagsToSnapshot

      public final Boolean copyTagsToSnapshot()

      Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • domain

      public final String domain()

      The Active Directory directory ID to create the DB cluster in.

      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 Cluster Type: Aurora DB clusters only

      Returns:
      The Active Directory directory ID to create the DB cluster in.

      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 Cluster Type: Aurora DB clusters only

    • domainIAMRoleName

      public final String domainIAMRoleName()

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

      Valid for Cluster Type: Aurora DB clusters only

      Returns:
      The name of the IAM role to use when making API calls to the Directory Service.

      Valid for Cluster Type: Aurora DB clusters only

    • enableGlobalWriteForwarding

      public final Boolean enableGlobalWriteForwarding()

      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

      Returns:
      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

    • dbClusterInstanceClass

      public final String dbClusterInstanceClass()

      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 Amazon Web Services 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

      Returns:
      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 Amazon Web Services 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

    • allocatedStorage

      public final Integer allocatedStorage()

      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.

      Returns:
      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.

    • storageType

      public final String storageType()

      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

      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.

      Returns:
      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

      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.

    • iops

      public final Integer iops()

      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.

      Returns:
      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.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.

      Returns:
      Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

      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

      Returns:
      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

    • monitoringInterval

      public final Integer monitoringInterval()

      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

      Returns:
      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

    • monitoringRoleArn

      public final String monitoringRoleArn()

      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

      Returns:
      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

    • enablePerformanceInsights

      public final Boolean enablePerformanceInsights()

      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

      Returns:
      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

    • performanceInsightsKMSKeyId

      public final String performanceInsightsKMSKeyId()

      The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

      The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Multi-AZ DB clusters only

      Returns:
      The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

      The Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Valid for Cluster Type: Multi-AZ DB clusters only

    • performanceInsightsRetentionPeriod

      public final Integer performanceInsightsRetentionPeriod()

      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.

      Returns:
      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.

    • serverlessV2ScalingConfiguration

      public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()
      Returns the value of the ServerlessV2ScalingConfiguration property for this object.
      Returns:
      The value of the ServerlessV2ScalingConfiguration property for this object.

    • networkType

      public final String networkType()

      The network type of the DB cluster.

      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 the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: IPV4 | DUAL

      Returns:
      The network type of the DB cluster.

      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 the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

      Valid Values: IPV4 | DUAL

    • dbSystemId

      public final String dbSystemId()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • manageMasterUserPassword

      public final Boolean manageMasterUserPassword()

      Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services 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 Amazon Web Services Secrets Manager if MasterUserPassword is specified.

      Returns:
      Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services 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 Amazon Web Services Secrets Manager if MasterUserPassword is specified.

    • masterUserSecretKmsKeyId

      public final String masterUserSecretKmsKeyId()

      The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if the master user password is managed by RDS 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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Returns:
      The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if the master user password is managed by RDS 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.

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • enableLocalWriteForwarding

      public final Boolean enableLocalWriteForwarding()

      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

      Returns:
      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

    • sourceRegion

      public final String sourceRegion()
      If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
      Returns:
      If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

    • toBuilder

      public CreateDbClusterRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDbClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDbClusterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.