Class RestoreDbClusterFromSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,
RestoreDbClusterFromSnapshotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionProvides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.final Long
The target backtrack window, in seconds.builder()
final Boolean
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.final String
The database name for the restored DB cluster.final String
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.final String
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.final String
The name of the DB cluster parameter group to associate with this DB cluster.final String
The name of the DB subnet group to use for the new DB cluster.final Boolean
Specifies whether to enable deletion protection for the DB cluster.final String
domain()
The Active Directory directory ID to restore the DB cluster in.final String
The name of the IAM role to be used when making API calls to the Directory Service.The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.final Boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.final String
engine()
The database engine to use for the new DB cluster.final String
The DB engine mode of the DB cluster, eitherprovisioned
orserverless
.final String
The version of the database engine to use for the new DB cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AvailabilityZones property.final boolean
For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.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.final String
kmsKeyId()
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.final String
The network type of the DB cluster.final String
The name of the option group to use for the restored DB cluster.final Integer
port()
The port number on which the new DB cluster accepts connections.final Boolean
Specifies whether the DB cluster is publicly accessible.Reserved for future use.final ScalingConfiguration
For DB clusters inserverless
DB engine mode, the scaling properties of the DB cluster.static Class
<? extends RestoreDbClusterFromSnapshotRequest.Builder> Returns the value of the ServerlessV2ScalingConfiguration property for this object.final String
The identifier for the DB snapshot or DB cluster snapshot to restore from.final String
Specifies the storage type to be associated with the DB cluster.tags()
The tags to be assigned to the restored DB cluster.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.A list of VPC security groups that the new DB cluster will belong to.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 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. -
availabilityZones
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: 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:
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be
created.
Valid for: Aurora DB clusters only
-
dbClusterIdentifier
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
case-sensitive.
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-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
snapshotIdentifier
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
-
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
-
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
engine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
engineVersion
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The version of the database engine to use for the new DB cluster. If you don't specify an engine version,
the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
port
The port number on which the new DB cluster accepts connections.
Constraints: This value must be
1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The port number on which the new DB cluster accepts connections.
Constraints: This value must be
1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
dbSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example:
mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
databaseName
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- Returns:
- The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
optionGroupName
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
- Returns:
- The name of the option group to use for the restored 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
A list of VPC security groups that the new DB cluster will belong 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 will belong 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
The tags to be assigned to the restored DB cluster.
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
hasTags()
method.- Returns:
- The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
kmsKeyId
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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 you don't specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. -
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn't encrypted, then the restored DB cluster isn't encrypted.
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 a DB
snapshot or DB cluster snapshot.
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 you don't specify a value for the
KmsKeyId
parameter, then the following occurs:-
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. -
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
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: 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: Aurora DB clusters only
-
backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
- Returns:
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora 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
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.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 Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used.
RDS for MySQL
Possible values are
error
,general
, andslowquery
.RDS for PostgreSQL
Possible values are
postgresql
andupgrade
.Aurora MySQL
Possible values are
audit
,error
,general
, andslowquery
.Aurora PostgreSQL
Possible value is
postgresql
.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
-
engineMode
The DB engine mode of the DB cluster, either
provisioned
orserverless
.For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
- Returns:
- The DB engine mode of the DB cluster, either
provisioned
orserverless
.For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
-
scalingConfiguration
For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
- Returns:
- For DB clusters in
serverless
DB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
-
dbClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
-
If supplied, must match the name of an existing default 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 DB cluster parameter group to associate with this DB cluster. If this argument is
omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
-
If supplied, must match the name of an existing default 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
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
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
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS 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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be
created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
-
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
-
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
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iops
parameter 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
Iops
parameter 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
-
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: Aurora DB clusters and Multi-AZ DB clusters
- 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: Aurora DB clusters and Multi-AZ DB clusters
-
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
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn't specified, andPubliclyAccessible
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, andPubliclyAccessible
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
- 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
DBSubnetGroupName
is specified.If
DBSubnetGroupName
isn't specified, andPubliclyAccessible
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, andPubliclyAccessible
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
-
-
-
serverlessV2ScalingConfiguration
Returns the value of the ServerlessV2ScalingConfiguration property for this object.- Returns:
- The value of the ServerlessV2ScalingConfiguration property for this object.
-
networkType
The network type of the DB cluster.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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: Aurora DB clusters only
- Returns:
- The network type of the DB cluster.
Valid Values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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: Aurora DB clusters only
-
-
-
rdsCustomClusterConfiguration
Reserved for future use.
- Returns:
- Reserved for future use.
-
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 interfaceToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,
RestoreDbClusterFromSnapshotRequest> - Specified by:
toBuilder
in classRdsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends RestoreDbClusterFromSnapshotRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-