Class RestoreFromSnapshotRequest

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

  • Method Details

    • adminPasswordSecretKmsKeyId

      public final String 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

      public final Boolean manageAdminPassword()

      If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword 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. If MmanageAdminPassword 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

      public final String namespaceName()

      The name of the namespace to restore the snapshot to.

      Returns:
      The name of the namespace to restore the snapshot to.

    • ownerAccount

      public final String ownerAccount()

      The Amazon Web Services account that owns the snapshot.

      Returns:
      The Amazon Web Services account that owns the snapshot.

    • snapshotArn

      public final String snapshotArn()

      The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. 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: '&lt' ;snapshot_identifier>.

      Returns:
      The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. 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

      public final String 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

      public final String workgroupName()

      The name of the workgroup used to restore the snapshot.

      Returns:
      The name of the workgroup used to restore the snapshot.

    • toBuilder

      public RestoreFromSnapshotRequest.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<RestoreFromSnapshotRequest.Builder,RestoreFromSnapshotRequest>
      Specified by:
      toBuilder in class RedshiftServerlessRequest
      Returns:
      a builder for type T

    • builder

      public static RestoreFromSnapshotRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RestoreFromSnapshotRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.