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

Class CreateSnapshotRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

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

Represents the input of a CreateSnapshot operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSnapshotRequest.Builder	builder()
String	cacheClusterId()	The identifier of an existing cluster.
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 snapshot.
String	replicationGroupId()	The identifier of an existing replication group.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotName()	A name for the snapshot being created.
List<Tag>	tags()	A list of tags to be added to this resource.
CreateSnapshotRequest.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

replicationGroupId

public final String replicationGroupId()

The identifier of an existing replication group. The snapshot is created from this replication group.

Returns:

The identifier of an existing replication group. The snapshot is created from this replication group.

cacheClusterId

public final String cacheClusterId()

The identifier of an existing cluster. The snapshot is created from this cluster.

Returns:

The identifier of an existing cluster. The snapshot is created from this cluster.

snapshotName

public final String snapshotName()

A name for the snapshot being created.

Returns:

A name for the snapshot being created.

kmsKeyId

public final String kmsKeyId()

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

Returns:

The ID of the KMS key used to encrypt the 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 CreateSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static CreateSnapshotRequest.Builder builder()

serializableBuilderClass

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