elasticache/aws.sdk.kotlin.services.elasticache.model/DescribeSnapshotsRequest

DescribeSnapshotsRequest

class DescribeSnapshotsRequest

Represents the input of a DescribeSnapshotsMessage operation.

Types

Builder

class Builder

Companion

object Companion

Properties

cacheClusterId

val cacheClusterId: String?

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

marker

val marker: String?

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

maxRecords

val maxRecords: Int?

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

replicationGroupId

val replicationGroupId: String?

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

showNodeGroupConfig

val showNodeGroupConfig: Boolean?

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

snapshotName

val snapshotName: String?

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

snapshotSource

val snapshotSource: String?

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Functions

copy

inline fun copy(block: DescribeSnapshotsRequest.Builder.() -> Unit = {}): DescribeSnapshotsRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String