Package software.amazon.awssdk.services.elasticache.model

Class CopySnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.CopySnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CopySnapshotRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

Represents the input of a CopySnapshotMessage operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopySnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CopySnapshotRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId()	The ID of the KMS key used to encrypt the target snapshot.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CopySnapshotRequest.Builder>	serializableBuilderClass()
String	sourceSnapshotName()	The name of an existing snapshot from which to make a copy.
List<Tag>	tags()	A list of tags to be added to this resource.
String	targetBucket()	The Amazon S3 bucket to which the snapshot is exported.
String	targetSnapshotName()	A name for the snapshot copy.
CopySnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourceSnapshotName

public final String sourceSnapshotName()

The name of an existing snapshot from which to make a copy.

Returns:

The name of an existing snapshot from which to make a copy.

targetSnapshotName

public final String targetSnapshotName()

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Returns:

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

targetBucket

public final String targetBucket()

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

Returns:

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

kmsKeyId

public final String kmsKeyId()

The ID of the KMS key used to encrypt the target snapshot.

Returns:

The ID of the KMS key used to encrypt the target snapshot.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

toBuilder

public CopySnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static CopySnapshotRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo