/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include See Also:
AWS
* API Reference
The identifier of the cluster which generated the requested snapshots.
*/ inline const Aws::String& GetClusterIdentifier() const{ return m_clusterIdentifier; } /** *The identifier of the cluster which generated the requested snapshots.
*/ inline bool ClusterIdentifierHasBeenSet() const { return m_clusterIdentifierHasBeenSet; } /** *The identifier of the cluster which generated the requested snapshots.
*/ inline void SetClusterIdentifier(const Aws::String& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = value; } /** *The identifier of the cluster which generated the requested snapshots.
*/ inline void SetClusterIdentifier(Aws::String&& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = std::move(value); } /** *The identifier of the cluster which generated the requested snapshots.
*/ inline void SetClusterIdentifier(const char* value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier.assign(value); } /** *The identifier of the cluster which generated the requested snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithClusterIdentifier(const Aws::String& value) { SetClusterIdentifier(value); return *this;} /** *The identifier of the cluster which generated the requested snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithClusterIdentifier(Aws::String&& value) { SetClusterIdentifier(std::move(value)); return *this;} /** *The identifier of the cluster which generated the requested snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithClusterIdentifier(const char* value) { SetClusterIdentifier(value); return *this;} /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline const Aws::String& GetSnapshotIdentifier() const{ return m_snapshotIdentifier; } /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline bool SnapshotIdentifierHasBeenSet() const { return m_snapshotIdentifierHasBeenSet; } /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline void SetSnapshotIdentifier(const Aws::String& value) { m_snapshotIdentifierHasBeenSet = true; m_snapshotIdentifier = value; } /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline void SetSnapshotIdentifier(Aws::String&& value) { m_snapshotIdentifierHasBeenSet = true; m_snapshotIdentifier = std::move(value); } /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline void SetSnapshotIdentifier(const char* value) { m_snapshotIdentifierHasBeenSet = true; m_snapshotIdentifier.assign(value); } /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotIdentifier(const Aws::String& value) { SetSnapshotIdentifier(value); return *this;} /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotIdentifier(Aws::String&& value) { SetSnapshotIdentifier(std::move(value)); return *this;} /** *The snapshot identifier of the snapshot about which to return * information.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotIdentifier(const char* value) { SetSnapshotIdentifier(value); return *this;} /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline const Aws::String& GetSnapshotArn() const{ return m_snapshotArn; } /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline bool SnapshotArnHasBeenSet() const { return m_snapshotArnHasBeenSet; } /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline void SetSnapshotArn(const Aws::String& value) { m_snapshotArnHasBeenSet = true; m_snapshotArn = value; } /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline void SetSnapshotArn(Aws::String&& value) { m_snapshotArnHasBeenSet = true; m_snapshotArn = std::move(value); } /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline void SetSnapshotArn(const char* value) { m_snapshotArnHasBeenSet = true; m_snapshotArn.assign(value); } /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotArn(const Aws::String& value) { SetSnapshotArn(value); return *this;} /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotArn(Aws::String&& value) { SetSnapshotArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the snapshot associated with the message to * describe cluster snapshots.
*/ inline DescribeClusterSnapshotsRequest& WithSnapshotArn(const char* value) { SetSnapshotArn(value); return *this;} /** *The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
The type of snapshots for which you are requesting information. By default, * snapshots of all types are returned.
Valid Values: automated
* | manual
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A value that requests only snapshots created at or after the specified time. * The time value is specified in ISO 8601 format. For more information about ISO * 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified * time. The time value is specified in ISO 8601 format. For more information about * ISO 8601, go to the ISO8601 * Wikipedia page.
Example: 2012-07-16T18:00:00Z
The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified MaxRecords
* value, a value is returned in a marker
field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value.
Default: 100
Constraints: minimum 20, * maximum 100.
*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** *The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified MaxRecords
* value, a value is returned in a marker
field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value.
Default: 100
Constraints: minimum 20, * maximum 100.
*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified MaxRecords
* value, a value is returned in a marker
field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value.
Default: 100
Constraints: minimum 20, * maximum 100.
*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *The maximum number of response records to return in each call. If the number
* of remaining response records exceeds the specified MaxRecords
* value, a value is returned in a marker
field of the response. You
* can retrieve the next set of records by retrying the command with the returned
* marker value.
Default: 100
Constraints: minimum 20, * maximum 100.
*/ inline DescribeClusterSnapshotsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
An optional parameter that specifies the starting point to return a set of
* response records. When the results of a DescribeClusterSnapshots request
* exceed the value specified in MaxRecords
, Amazon Web Services
* returns a value in the Marker
field of the response. You can
* retrieve the next set of response records by providing the returned marker value
* in the Marker
parameter and retrying the request.
The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline const Aws::String& GetOwnerAccount() const{ return m_ownerAccount; } /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline bool OwnerAccountHasBeenSet() const { return m_ownerAccountHasBeenSet; } /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline void SetOwnerAccount(const Aws::String& value) { m_ownerAccountHasBeenSet = true; m_ownerAccount = value; } /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline void SetOwnerAccount(Aws::String&& value) { m_ownerAccountHasBeenSet = true; m_ownerAccount = std::move(value); } /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline void SetOwnerAccount(const char* value) { m_ownerAccountHasBeenSet = true; m_ownerAccount.assign(value); } /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline DescribeClusterSnapshotsRequest& WithOwnerAccount(const Aws::String& value) { SetOwnerAccount(value); return *this;} /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline DescribeClusterSnapshotsRequest& WithOwnerAccount(Aws::String&& value) { SetOwnerAccount(std::move(value)); return *this;} /** *The Amazon Web Services account used to create or copy the snapshot. Use this * field to filter the results to snapshots owned by a particular account. To * describe snapshots you own, either specify your Amazon Web Services account, or * do not specify the parameter.
*/ inline DescribeClusterSnapshotsRequest& WithOwnerAccount(const char* value) { SetOwnerAccount(value); return *this;} /** *A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots
* that are associated with the specified key or keys. For example, suppose that
* you have snapshots that are tagged with keys called owner
and
* environment
. If you specify both of these tag keys in the request,
* Amazon Redshift returns a response with the snapshots that have either or both
* of these tag keys associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster
* snapshots that are associated with the specified tag value or values. For
* example, suppose that you have snapshots that are tagged with values called
* admin
and test
. If you specify both of these tag
* values in the request, Amazon Redshift returns a response with the snapshots
* that have either or both of these tag values associated with them.
A value that indicates whether to return snapshots only for an existing * cluster. You can perform table-level restore only by using a snapshot of an * existing cluster, that is, a cluster that has not been deleted. Values for this * parameter work as follows:
If ClusterExists
is
* set to true
, ClusterIdentifier
is required.
If ClusterExists
is set to false
and
* ClusterIdentifier
isn't specified, all snapshots associated with
* deleted clusters (orphaned snapshots) are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for a deleted cluster, snapshots
* associated with that cluster are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for an existing cluster, no
* snapshots are returned.
A value that indicates whether to return snapshots only for an existing * cluster. You can perform table-level restore only by using a snapshot of an * existing cluster, that is, a cluster that has not been deleted. Values for this * parameter work as follows:
If ClusterExists
is
* set to true
, ClusterIdentifier
is required.
If ClusterExists
is set to false
and
* ClusterIdentifier
isn't specified, all snapshots associated with
* deleted clusters (orphaned snapshots) are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for a deleted cluster, snapshots
* associated with that cluster are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for an existing cluster, no
* snapshots are returned.
A value that indicates whether to return snapshots only for an existing * cluster. You can perform table-level restore only by using a snapshot of an * existing cluster, that is, a cluster that has not been deleted. Values for this * parameter work as follows:
If ClusterExists
is
* set to true
, ClusterIdentifier
is required.
If ClusterExists
is set to false
and
* ClusterIdentifier
isn't specified, all snapshots associated with
* deleted clusters (orphaned snapshots) are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for a deleted cluster, snapshots
* associated with that cluster are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for an existing cluster, no
* snapshots are returned.
A value that indicates whether to return snapshots only for an existing * cluster. You can perform table-level restore only by using a snapshot of an * existing cluster, that is, a cluster that has not been deleted. Values for this * parameter work as follows:
If ClusterExists
is
* set to true
, ClusterIdentifier
is required.
If ClusterExists
is set to false
and
* ClusterIdentifier
isn't specified, all snapshots associated with
* deleted clusters (orphaned snapshots) are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for a deleted cluster, snapshots
* associated with that cluster are returned.
If
* ClusterExists
is set to false
and
* ClusterIdentifier
is specified for an existing cluster, no
* snapshots are returned.