Class RestoreDbClusterFromSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,
RestoreDbClusterFromSnapshotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionProvides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.builder()
final Boolean
If set totrue
, tags are copied to any snapshot of the restored DB cluster that is created.final String
Not supported.final String
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.final String
The name of the DB cluster parameter group to associate with the new DB cluster.final String
The name of the DB subnet group to use for the new DB cluster.final Boolean
A value that indicates whether the DB cluster has deletion protection enabled.The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.final Boolean
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.final String
engine()
The database engine to use for the new DB cluster.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 String
kmsKeyId()
The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.final String
(Not supported by Neptune)final Integer
port()
The port number on which the new DB cluster accepts connections.static Class
<? extends RestoreDbClusterFromSnapshotRequest.Builder> Contains the scaling configuration of a Neptune Serverless DB cluster.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 EC2 Availability Zones that instances in the restored DB cluster can be created in.
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 EC2 Availability Zones that instances in the restored DB cluster can be created in.
-
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
-
Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- 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
-
Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
-
-
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.
- 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.
-
-
-
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
- 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
-
engineVersion
The version of the database engine to use for the new DB cluster.
- Returns:
- The version of the database engine to use for the new DB cluster.
-
port
The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
- Returns:
- The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
-
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 DBSubnetGroup.
Example:
mySubnetgroup
- 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 DBSubnetGroup.
Example:
mySubnetgroup
-
databaseName
Not supported.
- Returns:
- Not supported.
-
optionGroupName
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
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.
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.
-
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.
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.
-
kmsKeyId
The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:-
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
is not encrypted, then the restored DB cluster is not encrypted.
- Returns:
- The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB
cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:-
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
is not encrypted, then the restored DB cluster is not encrypted.
-
-
-
enableIAMDatabaseAuthentication
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default:
false
- Returns:
- True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default:
false
-
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.
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.
-
dbClusterParameterGroupName
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
- Returns:
- The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
-
If supplied, must match the name of an existing DBClusterParameterGroup.
-
-
-
deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
- Returns:
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
-
copyTagsToSnapshot
If set to
true
, tags are copied to any snapshot of the restored DB cluster that is created.- Returns:
- If set to
true
, tags are copied to any snapshot of the restored DB cluster that is created.
-
serverlessV2ScalingConfiguration
Contains the scaling configuration of a Neptune Serverless DB cluster.
For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
- Returns:
- Contains the scaling configuration of a Neptune Serverless DB cluster.
For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
-
storageType
Specifies the storage type to be associated with the DB cluster.
Valid values:
standard
,iopt1
Default:
standard
- Returns:
- Specifies the storage type to be associated with the DB cluster.
Valid values:
standard
,iopt1
Default:
standard
-
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 classNeptuneRequest
- 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
-