« blib/lib/Paws/DocDB/DescribeDBClusterSnapshotAttributesResult.pm
↑ Summary
blib/lib/Paws/DocDB/DescribeDBClusters.pm »
| 1 | |||
| 2 | package Paws::DocDB::DescribeDBClusterSnapshots; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]'); | ||
| 7 | has IncludePublic => (is => 'ro', isa => 'Bool'); | ||
| 8 | has IncludeShared => (is => 'ro', isa => 'Bool'); | ||
| 9 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 10 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 11 | has SnapshotType => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterSnapshots'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::DBClusterSnapshotMessage'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterSnapshotsResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::DocDB::DescribeDBClusterSnapshots - Arguments for method DescribeDBClusterSnapshots on L<Paws::DocDB> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method DescribeDBClusterSnapshots on the | ||
| 29 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 30 | as arguments to method DescribeDBClusterSnapshots. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusterSnapshots. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $rds = Paws->service('DocDB'); | ||
| 37 | my $DBClusterSnapshotMessage = $rds->DescribeDBClusterSnapshots( | ||
| 38 | DBClusterIdentifier => 'MyString', # OPTIONAL | ||
| 39 | DBClusterSnapshotIdentifier => 'MyString', # OPTIONAL | ||
| 40 | Filters => [ | ||
| 41 | { | ||
| 42 | Name => 'MyString', | ||
| 43 | Values => [ 'MyString', ... ], | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | IncludePublic => 1, # OPTIONAL | ||
| 49 | IncludeShared => 1, # OPTIONAL | ||
| 50 | Marker => 'MyString', # OPTIONAL | ||
| 51 | MaxRecords => 1, # OPTIONAL | ||
| 52 | SnapshotType => 'MyString', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $DBClusterSnapshots = $DBClusterSnapshotMessage->DBClusterSnapshots; | ||
| 57 | my $Marker = $DBClusterSnapshotMessage->Marker; | ||
| 58 | |||
| 59 | # Returns a L<Paws::DocDB::DBClusterSnapshotMessage> object. | ||
| 60 | |||
| 61 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusterSnapshots> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 DBClusterIdentifier => Str | ||
| 68 | |||
| 69 | The ID of the cluster to retrieve the list of cluster snapshots for. | ||
| 70 | This parameter can't be used with the C<DBClusterSnapshotIdentifier> | ||
| 71 | parameter. This parameter is not case sensitive. | ||
| 72 | |||
| 73 | Constraints: | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | If provided, must match the identifier of an existing C<DBCluster>. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 DBClusterSnapshotIdentifier => Str | ||
| 87 | |||
| 88 | A specific cluster snapshot identifier to describe. This parameter | ||
| 89 | can't be used with the C<DBClusterIdentifier> parameter. This value is | ||
| 90 | stored as a lowercase string. | ||
| 91 | |||
| 92 | Constraints: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | If provided, must match the identifier of an existing | ||
| 99 | C<DBClusterSnapshot>. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | If this identifier is for an automated snapshot, the C<SnapshotType> | ||
| 104 | parameter must also be specified. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 Filters => ArrayRef[L<Paws::DocDB::Filter>] | ||
| 112 | |||
| 113 | This parameter is not currently supported. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 IncludePublic => Bool | ||
| 118 | |||
| 119 | Set to C<true> to include manual cluster snapshots that are public and | ||
| 120 | can be copied or restored by any account, and otherwise C<false>. The | ||
| 121 | default is C<false>. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 IncludeShared => Bool | ||
| 126 | |||
| 127 | Set to C<true> to include shared manual cluster snapshots from other | ||
| 128 | accounts that this account has been given permission to copy or | ||
| 129 | restore, and otherwise C<false>. The default is C<false>. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 Marker => Str | ||
| 134 | |||
| 135 | An optional pagination token provided by a previous request. If this | ||
| 136 | parameter is specified, the response includes only records beyond the | ||
| 137 | marker, up to the value specified by C<MaxRecords>. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 MaxRecords => Int | ||
| 142 | |||
| 143 | The maximum number of records to include in the response. If more | ||
| 144 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 145 | token (marker) is included in the response so that the remaining | ||
| 146 | results can be retrieved. | ||
| 147 | |||
| 148 | Default: 100 | ||
| 149 | |||
| 150 | Constraints: Minimum 20, maximum 100. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 SnapshotType => Str | ||
| 155 | |||
| 156 | The type of cluster snapshots to be returned. You can specify one of | ||
| 157 | the following values: | ||
| 158 | |||
| 159 | =over | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<automated> - Return all cluster snapshots that Amazon DocumentDB has | ||
| 164 | automatically created for your account. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | C<manual> - Return all cluster snapshots that you have manually created | ||
| 169 | for your account. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | C<shared> - Return all manual cluster snapshots that have been shared | ||
| 174 | to your account. | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | C<public> - Return all cluster snapshots that have been marked as | ||
| 179 | public. | ||
| 180 | |||
| 181 | =back | ||
| 182 | |||
| 183 | If you don't specify a C<SnapshotType> value, then both automated and | ||
| 184 | manual cluster snapshots are returned. You can include shared cluster | ||
| 185 | snapshots with these results by setting the C<IncludeShared> parameter | ||
| 186 | to C<true>. You can include public cluster snapshots with these results | ||
| 187 | by setting theC<IncludePublic> parameter to C<true>. | ||
| 188 | |||
| 189 | The C<IncludeShared> and C<IncludePublic> parameters don't apply for | ||
| 190 | C<SnapshotType> values of C<manual> or C<automated>. The | ||
| 191 | C<IncludePublic> parameter doesn't apply when C<SnapshotType> is set to | ||
| 192 | C<shared>. The C<IncludeShared> parameter doesn't apply when | ||
| 193 | C<SnapshotType> is set to C<public>. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head1 SEE ALSO | ||
| 199 | |||
| 200 | This class forms part of L<Paws>, documenting arguments for method DescribeDBClusterSnapshots in L<Paws::DocDB> | ||
| 201 | |||
| 202 | =head1 BUGS and CONTRIBUTIONS | ||
| 203 | |||
| 204 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 205 | |||
| 206 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 207 | |||
| 208 | =cut | ||
| 209 |