EnableSnapshotCopyRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.redshift.model

Class EnableSnapshotCopyRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.redshift.model.EnableSnapshotCopyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EnableSnapshotCopyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

EnableSnapshotCopyRequest ()

Constructors
Constructor and Description
`EnableSnapshotCopyRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`EnableSnapshotCopyRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getClusterIdentifier ()` The unique identifier of the source cluster to copy snapshots from.
`String`	`getDestinationRegion ()` The destination Amazon Web Services Region that you want to copy snapshots to.
`Integer`	`getManualSnapshotRetentionPeriod ()` The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
`Integer`	`getRetentionPeriod ()` The number of days to retain automated snapshots in the destination region after they are copied from the source region.
`String`	`getSnapshotCopyGrantName ()` The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
`int`	`hashCode ()`
`void`	`setClusterIdentifier (String clusterIdentifier)` The unique identifier of the source cluster to copy snapshots from.
`void`	`setDestinationRegion (String destinationRegion)` The destination Amazon Web Services Region that you want to copy snapshots to.
`void`	`setManualSnapshotRetentionPeriod (Integer manualSnapshotRetentionPeriod)` The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
`void`	`setRetentionPeriod (Integer retentionPeriod)` The number of days to retain automated snapshots in the destination region after they are copied from the source region.
`void`	`setSnapshotCopyGrantName (String snapshotCopyGrantName)` The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
`String`	`toString ()` Returns a string representation of this object.
`EnableSnapshotCopyRequest`	`withClusterIdentifier (String clusterIdentifier)` The unique identifier of the source cluster to copy snapshots from.
`EnableSnapshotCopyRequest`	`withDestinationRegion (String destinationRegion)` The destination Amazon Web Services Region that you want to copy snapshots to.
`EnableSnapshotCopyRequest`	`withManualSnapshotRetentionPeriod (Integer manualSnapshotRetentionPeriod)` The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
`EnableSnapshotCopyRequest`	`withRetentionPeriod (Integer retentionPeriod)` The number of days to retain automated snapshots in the destination region after they are copied from the source region.
`EnableSnapshotCopyRequest`	`withSnapshotCopyGrantName (String snapshotCopyGrantName)` The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnableSnapshotCopyRequest
```
public EnableSnapshotCopyRequest()
```
- Method Detail
  - setClusterIdentifier
```
public void setClusterIdentifier(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.
    
    Parameters:
    
    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.
  - getClusterIdentifier
```
public String getClusterIdentifier()
```
    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.
  - withClusterIdentifier
```
public EnableSnapshotCopyRequest withClusterIdentifier(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationRegion
```
public void setDestinationRegion(String destinationRegion)
```
    The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    Parameters:
    
    destinationRegion - The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
  - getDestinationRegion
```
public String getDestinationRegion()
```
    The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    Returns:
    
    The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
  - withDestinationRegion
```
public EnableSnapshotCopyRequest withDestinationRegion(String destinationRegion)
```
    The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    Parameters:
    
    destinationRegion - The destination Amazon Web Services Region that you want to copy snapshots to.
    
    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetentionPeriod
```
public void setRetentionPeriod(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.
    
    Parameters:
    
    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.
  - getRetentionPeriod
```
public Integer getRetentionPeriod()
```
    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.
  - withRetentionPeriod
```
public EnableSnapshotCopyRequest withRetentionPeriod(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotCopyGrantName
```
public void setSnapshotCopyGrantName(String snapshotCopyGrantName)
```
    The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
    
    Parameters:
    
    snapshotCopyGrantName - The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
  - getSnapshotCopyGrantName
```
public String getSnapshotCopyGrantName()
```
    The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
    
    Returns:
    
    The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
  - withSnapshotCopyGrantName
```
public EnableSnapshotCopyRequest withSnapshotCopyGrantName(String snapshotCopyGrantName)
```
    The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
    
    Parameters:
    
    snapshotCopyGrantName - The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setManualSnapshotRetentionPeriod
```
public void setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
```
    The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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.
    
    Parameters:
    
    manualSnapshotRetentionPeriod - The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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.
  - getManualSnapshotRetentionPeriod
```
public Integer getManualSnapshotRetentionPeriod()
```
    The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region after they are copied from the source Amazon Web Services 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.
  - withManualSnapshotRetentionPeriod
```
public EnableSnapshotCopyRequest withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
```
    The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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.
    
    Parameters:
    
    manualSnapshotRetentionPeriod - The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EnableSnapshotCopyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class EnableSnapshotCopyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

EnableSnapshotCopyRequest

Method Detail

setClusterIdentifier

getClusterIdentifier

withClusterIdentifier

setDestinationRegion

getDestinationRegion

withDestinationRegion

setRetentionPeriod

getRetentionPeriod

withRetentionPeriod

setSnapshotCopyGrantName

getSnapshotCopyGrantName

withSnapshotCopyGrantName

setManualSnapshotRetentionPeriod

getManualSnapshotRetentionPeriod

withManualSnapshotRetentionPeriod

toString

equals

hashCode

clone