Class RestoreDbClusterToPointInTimeRequest
- 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.RestoreDbClusterToPointInTimeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
@Generated("software.amazon.awssdk:codegen") public final class RestoreDbClusterToPointInTimeRequest extends RdsRequest implements ToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRestoreDbClusterToPointInTimeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LongbacktrackWindow()The target backtrack window, in seconds.static RestoreDbClusterToPointInTimeRequest.Builderbuilder()BooleancopyTagsToSnapshot()Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.StringdbClusterIdentifier()The name of the new DB cluster to be created.StringdbClusterInstanceClass()The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.StringdbClusterParameterGroupName()The name of the custom DB cluster parameter group to associate with this DB cluster.StringdbSubnetGroupName()The DB subnet group name to use for the new DB cluster.BooleandeletionProtection()Specifies whether to enable deletion protection for the DB cluster.Stringdomain()The Active Directory directory ID to restore the DB cluster in.StringdomainIAMRoleName()The name of the IAM role to be used when making API calls to the Directory Service.List<String>enableCloudwatchLogsExports()The list of logs that the restored DB cluster is to export to CloudWatch Logs.BooleanenableIAMDatabaseAuthentication()Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.BooleanenablePerformanceInsights()Specifies whether to turn on Performance Insights for the DB cluster.StringengineLifecycleSupport()The life cycle type for this DB cluster.StringengineMode()The engine mode of the new cluster.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEnableCloudwatchLogsExports()For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasVpcSecurityGroupIds()For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.Integeriops()The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.StringkmsKeyId()The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.IntegermonitoringInterval()The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.StringmonitoringRoleArn()The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.StringnetworkType()The network type of the DB cluster.StringoptionGroupName()The name of the option group for the new DB cluster.StringperformanceInsightsKMSKeyId()The Amazon Web Services KMS key identifier for encryption of Performance Insights data.IntegerperformanceInsightsRetentionPeriod()The number of days to retain Performance Insights data.Integerport()The port number on which the new DB cluster accepts connections.BooleanpubliclyAccessible()Specifies whether the DB cluster is publicly accessible.RdsCustomClusterConfigurationrdsCustomClusterConfiguration()Reserved for future use.InstantrestoreToTime()The date and time to restore the DB cluster to.StringrestoreType()The type of restore to be performed.ScalingConfigurationscalingConfiguration()For DB clusters inserverlessDB engine mode, the scaling properties of the DB cluster.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder>serializableBuilderClass()ServerlessV2ScalingConfigurationserverlessV2ScalingConfiguration()Returns the value of the ServerlessV2ScalingConfiguration property for this object.StringsourceDBClusterIdentifier()The identifier of the source DB cluster from which to restore.StringsourceDbClusterResourceId()The resource ID of the source DB cluster from which to restore.StringstorageType()Specifies the storage type to be associated with the DB cluster.List<Tag>tags()Returns the value of the Tags property for this object.RestoreDbClusterToPointInTimeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuseLatestRestorableTime()Specifies whether to restore the DB cluster to the latest restorable backup time.List<String>vpcSecurityGroupIds()A list of VPC security groups that the new DB cluster belongs to.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dbClusterIdentifier
public final String dbClusterIdentifier()
The name of the new DB cluster to be created.
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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The name of the new DB cluster to be created.
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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
restoreType
public final String restoreType()
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
RestoreTypevalue, 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
- Returns:
- 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
RestoreTypevalue, 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
-
-
-
sourceDBClusterIdentifier
public final String sourceDBClusterIdentifier()
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
- Returns:
- 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
-
-
-
restoreToTime
public final Instant restoreToTime()
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
UseLatestRestorableTimeparameter isn't provided -
Can't be specified if the
UseLatestRestorableTimeparameter is enabled -
Can't be specified if the
RestoreTypeparameter iscopy-on-write
Example:
2015-03-07T23:45:00ZValid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- 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
UseLatestRestorableTimeparameter isn't provided -
Can't be specified if the
UseLatestRestorableTimeparameter is enabled -
Can't be specified if the
RestoreTypeparameter iscopy-on-write
Example:
2015-03-07T23:45:00ZValid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
useLatestRestorableTime
public final Boolean useLatestRestorableTime()
Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if
RestoreToTimeparameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB
cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if
RestoreToTimeparameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
port
public final Integer port()
The port number on which the new DB cluster accepts connections.
Constraints: A value from
1150-65535.Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The port number on which the new DB cluster accepts connections.
Constraints: A value from
1150-65535.Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
dbSubnetGroupName
public final String dbSubnetGroupName()
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
-
optionGroupName
public final String optionGroupName()
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
- Returns:
- The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
-
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 theisEmpty()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 VPC security groups that the new DB cluster belongs to.
Valid for: 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 VPC security groups that the new DB cluster belongs to.
Valid for: 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 theisEmpty()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()
Returns the value of the Tags property for this object.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:
- The value of the Tags property for this object.
-
kmsKeyId
public final String kmsKeyId()
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from 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.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyIdparameter.If you don't specify a value for the
KmsKeyIdparameter, then the following occurs:-
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
-
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If
DBClusterIdentifierrefers to a DB cluster that isn't encrypted, then the restore request is rejected.Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from 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.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyIdparameter.If you don't specify a value for the
KmsKeyIdparameter, then the following occurs:-
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
-
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If
DBClusterIdentifierrefers to a DB cluster that isn't encrypted, then the restore request is rejected.Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
backtrackWindow
public final Long backtrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
- Returns:
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
-
-
-
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 theisEmpty()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 logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error,general,slowquery, andiam-db-auth-error.RDS for PostgreSQL
Possible values are
postgresql,upgrade, andiam-db-auth-error.Aurora MySQL
Possible values are
audit,error,general,instance,slowquery, andiam-db-auth-error.Aurora PostgreSQL
Possible value are
instance,postgresql, andiam-db-auth-error.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.
Valid for: 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
hasEnableCloudwatchLogsExports()method.- Returns:
- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used.
RDS for MySQL
Possible values are
error,general,slowquery, andiam-db-auth-error.RDS for PostgreSQL
Possible values are
postgresql,upgrade, andiam-db-auth-error.Aurora MySQL
Possible values are
audit,error,general,instance,slowquery, andiam-db-auth-error.Aurora PostgreSQL
Possible value are
instance,postgresql, andiam-db-auth-error.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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
dbClusterParameterGroupName
public final String dbClusterParameterGroupName()
The name of the custom DB cluster parameter group to associate with this DB cluster.
If the
DBClusterParameterGroupNameparameter is omitted, the default DB cluster parameter group for the specified engine is used.Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The name of the custom DB cluster parameter group to associate with this DB cluster.
If the
DBClusterParameterGroupNameparameter is omitted, the default DB cluster parameter group for the specified engine is used.Constraints:
-
If supplied, must match the name of an existing DB cluster parameter group.
-
Must be 1 to 255 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
deletionProtection
public final Boolean deletionProtection()
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when
deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
copyTagsToSnapshot
public final Boolean copyTagsToSnapshot()
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
domain
public final String domain()
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
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
- Returns:
- The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this
operation.
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
-
domainIAMRoleName
public final String domainIAMRoleName()
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
- Returns:
- The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
-
scalingConfiguration
public final ScalingConfiguration scalingConfiguration()
For DB clusters in
serverlessDB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
- Returns:
- For DB clusters in
serverlessDB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
-
engineMode
public final String engineMode()
The engine mode of the new cluster. Specify
provisionedorserverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine modeserverless.Valid for: Aurora DB clusters only
- Returns:
- The engine mode of the new cluster. Specify
provisionedorserverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine modeserverless.Valid for: Aurora DB clusters only
-
dbClusterInstanceClass
public final String dbClusterInstanceClass()
The compute and memory capacity of the 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.
Valid for: Multi-AZ DB clusters only
- Returns:
- The compute and memory capacity of the 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.
Valid for: Multi-AZ DB clusters only
-
storageType
public final String storageType()
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iopsparameter is required.Valid Values:
aurora,aurora-iopt1(Aurora DB clusters);io1(Multi-AZ DB clusters)Default:
aurora(Aurora DB clusters);io1(Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iopsparameter is required.Valid Values:
aurora,aurora-iopt1(Aurora DB clusters);io1(Multi-AZ DB clusters)Default:
aurora(Aurora DB clusters);io1(Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
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 is not 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.
Default: The default behavior varies depending on whether
DBSubnetGroupNameis specified.If
DBSubnetGroupNameisn't specified, andPubliclyAccessibleisn'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
DBSubnetGroupNameis specified, andPubliclyAccessibleisn'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.
Valid for: Multi-AZ DB clusters only
- 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 is not 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.
Default: The default behavior varies depending on whether
DBSubnetGroupNameis specified.If
DBSubnetGroupNameisn't specified, andPubliclyAccessibleisn'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
DBSubnetGroupNameis specified, andPubliclyAccessibleisn'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.
Valid for: Multi-AZ DB clusters only
-
-
-
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 Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
- 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 Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
-
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.
Valid Values:
-
IPV4 -
DUAL
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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: Aurora DB clusters only
- Returns:
- The network type of the DB cluster.
Valid Values:
-
IPV4 -
DUAL
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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: Aurora DB clusters only
-
-
-
sourceDbClusterResourceId
public final String sourceDbClusterResourceId()
The resource ID of the source DB cluster from which to restore.
- Returns:
- The resource ID of the source DB cluster from which to restore.
-
rdsCustomClusterConfiguration
public final RdsCustomClusterConfiguration rdsCustomClusterConfiguration()
Reserved for future use.
- Returns:
- Reserved for future use.
-
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
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than0.Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60Default:
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
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than0.Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60Default:
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.If
MonitoringIntervalis set to a value other than0, supply aMonitoringRoleArnvalue.- 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.If
MonitoringIntervalis set to a value other than0, supply aMonitoringRoleArnvalue.
-
enablePerformanceInsights
public final Boolean enablePerformanceInsights()
Specifies whether to turn on Performance Insights for the DB cluster.
- Returns:
- Specifies whether to turn on Performance Insights for the DB cluster.
-
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.- 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.
-
performanceInsightsRetentionPeriod
public final Integer performanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
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:
7daysIf 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 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:
7daysIf you specify a retention period that isn't valid, such as
94, Amazon RDS issues an error. -
-
-
engineLifecycleSupport
public final String engineLifecycleSupport()
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 toopen-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine 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 - 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-disabledDefault:
open-source-rds-extended-support- Returns:
- 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 toopen-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine 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 - 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-disabledDefault:
open-source-rds-extended-support -
-
-
toBuilder
public RestoreDbClusterToPointInTimeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>- Specified by:
toBuilderin classRdsRequest
-
builder
public static RestoreDbClusterToPointInTimeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends RestoreDbClusterToPointInTimeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-