Class ModifySnapshotCopyRetentionPeriodRequest

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

  • Method Details

    • clusterIdentifier

      public final String clusterIdentifier()

      The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

      Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

      Returns:
      The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

      Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    • retentionPeriod

      public final Integer retentionPeriod()

      The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

      By default, this only changes the retention period of copied automated snapshots.

      If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

      Constraints: Must be at least 1 and no more than 35 for automated snapshots.

      If you specify the manual option, only newly copied manual snapshots will have the new retention period.

      If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

      Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

      Returns:
      The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

      By default, this only changes the retention period of copied automated snapshots.

      If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

      Constraints: Must be at least 1 and no more than 35 for automated snapshots.

      If you specify the manual option, only newly copied manual snapshots will have the new retention period.

      If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

      Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

    • manual

      public final Boolean manual()

      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

      Returns:
      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

    • toBuilder

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

    • builder

      public static ModifySnapshotCopyRetentionPeriodRequest.Builder builder()

    • serializableBuilderClass

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