Class RestoreFromSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RestoreFromSnapshotRequest.Builder,
RestoreFromSnapshotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.builder()
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 int
hashCode()
final Boolean
Iftrue
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.final String
The name of the namespace to restore the snapshot to.final String
The Amazon Web Services account that owns the snapshot.static Class
<? extends RestoreFromSnapshotRequest.Builder> final String
The Amazon Resource Name (ARN) of the snapshot to restore from.final String
The name of the snapshot to restore from.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.final String
The name of the workgroup used to restore the snapshot.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
- Returns:
- The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
-
manageAdminPassword
If
true
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPassword
is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.- Returns:
- If
true
, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. IfMmanageAdminPassword
is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
-
namespaceName
The name of the namespace to restore the snapshot to.
- Returns:
- The name of the namespace to restore the snapshot to.
-
ownerAccount
The Amazon Web Services account that owns the snapshot.
- Returns:
- The Amazon Web Services account that owns the snapshot.
-
snapshotArn
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as
snapshotName
.The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/invalid input: '<' ;snapshot_identifier>.
- Returns:
- The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon
Redshift Serverless to a provisioned cluster. Must not be specified at the same time as
snapshotName
.The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier >/<snapshot_identifier>.
-
snapshotName
The name of the snapshot to restore from. Must not be specified at the same time as
snapshotArn
.- Returns:
- The name of the snapshot to restore from. Must not be specified at the same time as
snapshotArn
.
-
workgroupName
The name of the workgroup used to restore the snapshot.
- Returns:
- The name of the workgroup used to restore the snapshot.
-
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<RestoreFromSnapshotRequest.Builder,
RestoreFromSnapshotRequest> - Specified by:
toBuilder
in classRedshiftServerlessRequest
- Returns:
- a builder for type T
-
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
-