1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Represents the input of a <code>DescribeSnapshotsMessage</code> operation.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeSnapshotsInput {
/// <p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>
pub replication_group_id: ::std::option::Option<::std::string::String>,
/// <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>
pub cache_cluster_id: ::std::option::Option<::std::string::String>,
/// <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>
pub snapshot_name: ::std::option::Option<::std::string::String>,
/// <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>
pub snapshot_source: ::std::option::Option<::std::string::String>,
/// <p>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 <code>MaxRecords</code>.</p>
pub marker: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
/// <p>Default: 50</p>
/// <p>Constraints: minimum 20; maximum 50.</p>
pub max_records: ::std::option::Option<i32>,
/// <p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>
pub show_node_group_config: ::std::option::Option<bool>,
}
impl DescribeSnapshotsInput {
/// <p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>
pub fn replication_group_id(&self) -> ::std::option::Option<&str> {
self.replication_group_id.as_deref()
}
/// <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>
pub fn cache_cluster_id(&self) -> ::std::option::Option<&str> {
self.cache_cluster_id.as_deref()
}
/// <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>
pub fn snapshot_name(&self) -> ::std::option::Option<&str> {
self.snapshot_name.as_deref()
}
/// <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>
pub fn snapshot_source(&self) -> ::std::option::Option<&str> {
self.snapshot_source.as_deref()
}
/// <p>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 <code>MaxRecords</code>.</p>
pub fn marker(&self) -> ::std::option::Option<&str> {
self.marker.as_deref()
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
/// <p>Default: 50</p>
/// <p>Constraints: minimum 20; maximum 50.</p>
pub fn max_records(&self) -> ::std::option::Option<i32> {
self.max_records
}
/// <p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>
pub fn show_node_group_config(&self) -> ::std::option::Option<bool> {
self.show_node_group_config
}
}
impl DescribeSnapshotsInput {
/// Creates a new builder-style object to manufacture [`DescribeSnapshotsInput`](crate::operation::describe_snapshots::DescribeSnapshotsInput).
pub fn builder() -> crate::operation::describe_snapshots::builders::DescribeSnapshotsInputBuilder {
crate::operation::describe_snapshots::builders::DescribeSnapshotsInputBuilder::default()
}
}
/// A builder for [`DescribeSnapshotsInput`](crate::operation::describe_snapshots::DescribeSnapshotsInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeSnapshotsInputBuilder {
pub(crate) replication_group_id: ::std::option::Option<::std::string::String>,
pub(crate) cache_cluster_id: ::std::option::Option<::std::string::String>,
pub(crate) snapshot_name: ::std::option::Option<::std::string::String>,
pub(crate) snapshot_source: ::std::option::Option<::std::string::String>,
pub(crate) marker: ::std::option::Option<::std::string::String>,
pub(crate) max_records: ::std::option::Option<i32>,
pub(crate) show_node_group_config: ::std::option::Option<bool>,
}
impl DescribeSnapshotsInputBuilder {
/// <p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>
pub fn replication_group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.replication_group_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>
pub fn set_replication_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.replication_group_id = input;
self
}
/// <p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>
pub fn get_replication_group_id(&self) -> &::std::option::Option<::std::string::String> {
&self.replication_group_id
}
/// <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>
pub fn cache_cluster_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.cache_cluster_id = ::std::option::Option::Some(input.into());
self
}
/// <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>
pub fn set_cache_cluster_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.cache_cluster_id = input;
self
}
/// <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>
pub fn get_cache_cluster_id(&self) -> &::std::option::Option<::std::string::String> {
&self.cache_cluster_id
}
/// <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>
pub fn snapshot_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.snapshot_name = ::std::option::Option::Some(input.into());
self
}
/// <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>
pub fn set_snapshot_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.snapshot_name = input;
self
}
/// <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>
pub fn get_snapshot_name(&self) -> &::std::option::Option<::std::string::String> {
&self.snapshot_name
}
/// <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>
pub fn snapshot_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.snapshot_source = ::std::option::Option::Some(input.into());
self
}
/// <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>
pub fn set_snapshot_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.snapshot_source = input;
self
}
/// <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>
pub fn get_snapshot_source(&self) -> &::std::option::Option<::std::string::String> {
&self.snapshot_source
}
/// <p>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 <code>MaxRecords</code>.</p>
pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.marker = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <code>MaxRecords</code>.</p>
pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.marker = input;
self
}
/// <p>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 <code>MaxRecords</code>.</p>
pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
&self.marker
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
/// <p>Default: 50</p>
/// <p>Constraints: minimum 20; maximum 50.</p>
pub fn max_records(mut self, input: i32) -> Self {
self.max_records = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
/// <p>Default: 50</p>
/// <p>Constraints: minimum 20; maximum 50.</p>
pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_records = input;
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p>
/// <p>Default: 50</p>
/// <p>Constraints: minimum 20; maximum 50.</p>
pub fn get_max_records(&self) -> &::std::option::Option<i32> {
&self.max_records
}
/// <p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>
pub fn show_node_group_config(mut self, input: bool) -> Self {
self.show_node_group_config = ::std::option::Option::Some(input);
self
}
/// <p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>
pub fn set_show_node_group_config(mut self, input: ::std::option::Option<bool>) -> Self {
self.show_node_group_config = input;
self
}
/// <p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>
pub fn get_show_node_group_config(&self) -> &::std::option::Option<bool> {
&self.show_node_group_config
}
/// Consumes the builder and constructs a [`DescribeSnapshotsInput`](crate::operation::describe_snapshots::DescribeSnapshotsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_snapshots::DescribeSnapshotsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_snapshots::DescribeSnapshotsInput {
replication_group_id: self.replication_group_id,
cache_cluster_id: self.cache_cluster_id,
snapshot_name: self.snapshot_name,
snapshot_source: self.snapshot_source,
marker: self.marker,
max_records: self.max_records,
show_node_group_config: self.show_node_group_config,
})
}
}