software.amazon.awssdk.services.redshift.model

Class EnableSnapshotCopyRequest

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.EnableSnapshotCopyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableSnapshotCopyRequest.Builder,EnableSnapshotCopyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class EnableSnapshotCopyRequest
extends RedshiftRequest
implements ToCopyableBuilder<EnableSnapshotCopyRequest.Builder,EnableSnapshotCopyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EnableSnapshotCopyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static EnableSnapshotCopyRequest.Builder	builder()
String	clusterIdentifier() The unique identifier of the source cluster to copy snapshots from.
String	destinationRegion() The destination AWS Region that you want to copy snapshots to.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	manualSnapshotRetentionPeriod() The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region.
Integer	retentionPeriod() The number of days to retain automated snapshots in the destination region after they are copied from the source region.
List<SdkField<?>>	sdkFields()
static Class<? extends EnableSnapshotCopyRequest.Builder>	serializableBuilderClass()
String	snapshotCopyGrantName() The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
EnableSnapshotCopyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clusterIdentifier

public String clusterIdentifier()

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Returns:

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

destinationRegion

public String destinationRegion()

The destination AWS Region that you want to copy snapshots to.

Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Returns:

The destination AWS Region that you want to copy snapshots to.

Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

retentionPeriod

public Integer retentionPeriod()

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default: 7.

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

Returns:

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default: 7.

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

snapshotCopyGrantName

public String snapshotCopyGrantName()

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

Returns:

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

manualSnapshotRetentionPeriod

public Integer manualSnapshotRetentionPeriod()

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Returns:

The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

toBuilder

public EnableSnapshotCopyRequest.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<EnableSnapshotCopyRequest.Builder,EnableSnapshotCopyRequest>

Specified by:

toBuilder in class RedshiftRequest

Returns:

a builder for type T

builder

public static EnableSnapshotCopyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableSnapshotCopyRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.