/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the neptune-2014-10-31.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Neptune.Model
{
///
/// Container for the parameters to the DescribeDBClusterSnapshots operation.
/// Returns information about DB cluster snapshots. This API action supports pagination.
///
public partial class DescribeDBClusterSnapshotsRequest : AmazonNeptuneRequest
{
private string _dbClusterIdentifier;
private string _dbClusterSnapshotIdentifier;
private List _filters = new List();
private bool? _includePublic;
private bool? _includeShared;
private string _marker;
private int? _maxRecords;
private string _snapshotType;
///
/// Gets and sets the property DBClusterIdentifier.
///
/// The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter
/// can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter.
/// This parameter is not case-sensitive.
///
///
///
/// Constraints:
///
/// -
///
/// If supplied, must match the identifier of an existing DBCluster.
///
///
///
public string DBClusterIdentifier
{
get { return this._dbClusterIdentifier; }
set { this._dbClusterIdentifier = value; }
}
// Check to see if DBClusterIdentifier property is set
internal bool IsSetDBClusterIdentifier()
{
return this._dbClusterIdentifier != null;
}
///
/// Gets and sets the property DBClusterSnapshotIdentifier.
///
/// A specific DB cluster snapshot identifier to describe. This parameter can't be used
/// in conjunction with the DBClusterIdentifier
parameter. This value is
/// stored as a lowercase string.
///
///
///
/// Constraints:
///
/// -
///
/// If supplied, must match the identifier of an existing DBClusterSnapshot.
///
///
-
///
/// If this identifier is for an automated snapshot, the
SnapshotType
parameter
/// must also be specified.
///
///
///
public string DBClusterSnapshotIdentifier
{
get { return this._dbClusterSnapshotIdentifier; }
set { this._dbClusterSnapshotIdentifier = value; }
}
// Check to see if DBClusterSnapshotIdentifier property is set
internal bool IsSetDBClusterSnapshotIdentifier()
{
return this._dbClusterSnapshotIdentifier != null;
}
///
/// Gets and sets the property Filters.
///
/// This parameter is not currently supported.
///
///
public List Filters
{
get { return this._filters; }
set { this._filters = value; }
}
// Check to see if Filters property is set
internal bool IsSetFilters()
{
return this._filters != null && this._filters.Count > 0;
}
///
/// Gets and sets the property IncludePublic.
///
/// True to include manual DB cluster snapshots that are public and can be copied or restored
/// by any Amazon account, and otherwise false. The default is false
. The
/// default is false.
///
///
///
/// You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute
/// API action.
///
///
public bool IncludePublic
{
get { return this._includePublic.GetValueOrDefault(); }
set { this._includePublic = value; }
}
// Check to see if IncludePublic property is set
internal bool IsSetIncludePublic()
{
return this._includePublic.HasValue;
}
///
/// Gets and sets the property IncludeShared.
///
/// True to include shared manual DB cluster snapshots from other Amazon accounts that
/// this Amazon account has been given permission to copy or restore, and otherwise false.
/// The default is false
.
///
///
///
/// You can give an Amazon account permission to restore a manual DB cluster snapshot
/// from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
///
///
public bool IncludeShared
{
get { return this._includeShared.GetValueOrDefault(); }
set { this._includeShared = value; }
}
// Check to see if IncludeShared property is set
internal bool IsSetIncludeShared()
{
return this._includeShared.HasValue;
}
///
/// Gets and sets the property Marker.
///
/// An optional pagination token provided by a previous DescribeDBClusterSnapshots
/// request. If this parameter is specified, the response includes only records beyond
/// the marker, up to the value specified by MaxRecords
.
///
///
public string Marker
{
get { return this._marker; }
set { this._marker = value; }
}
// Check to see if Marker property is set
internal bool IsSetMarker()
{
return this._marker != null;
}
///
/// Gets and sets the property MaxRecords.
///
/// The maximum number of records to include in the response. If more records exist than
/// the specified MaxRecords
value, a pagination token called a marker is
/// included in the response so that the remaining results can be retrieved.
///
///
///
/// Default: 100
///
///
///
/// Constraints: Minimum 20, maximum 100.
///
///
public int MaxRecords
{
get { return this._maxRecords.GetValueOrDefault(); }
set { this._maxRecords = value; }
}
// Check to see if MaxRecords property is set
internal bool IsSetMaxRecords()
{
return this._maxRecords.HasValue;
}
///
/// Gets and sets the property SnapshotType.
///
/// The type of DB cluster snapshots to be returned. You can specify one of the following
/// values:
///
/// -
///
///
automated
- Return all DB cluster snapshots that have been automatically
/// taken by Amazon Neptune for my Amazon account.
///
/// -
///
///
manual
- Return all DB cluster snapshots that have been taken by my
/// Amazon account.
///
/// -
///
///
shared
- Return all manual DB cluster snapshots that have been shared
/// to my Amazon account.
///
/// -
///
///
public
- Return all DB cluster snapshots that have been marked as public.
///
///
///
/// If you don't specify a SnapshotType
value, then both automated and manual
/// DB cluster snapshots are returned. You can include shared DB cluster snapshots with
/// these results by setting the IncludeShared
parameter to true
.
/// You can include public DB cluster snapshots with these results by setting the IncludePublic
/// parameter to true
.
///
///
///
/// The IncludeShared
and IncludePublic
parameters don't apply
/// for SnapshotType
values of manual
or automated
.
/// The IncludePublic
parameter doesn't apply when SnapshotType
/// is set to shared
. The IncludeShared
parameter doesn't apply
/// when SnapshotType
is set to public
.
///
///
public string SnapshotType
{
get { return this._snapshotType; }
set { this._snapshotType = value; }
}
// Check to see if SnapshotType property is set
internal bool IsSetSnapshotType()
{
return this._snapshotType != null;
}
}
}