« blib/lib/Paws/RDS/DescribeCustomAvailabilityZones.pm
↑ Summary
blib/lib/Paws/RDS/DescribeDBClusterEndpoints.pm »
| 1 | |||
| 2 | package Paws::RDS::DescribeDBClusterBacktracks; | ||
| 3 | use Moose; | ||
| 4 | has BacktrackIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | ||
| 7 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterBacktracks'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBClusterBacktrackMessage'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterBacktracksResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RDS::DescribeDBClusterBacktracks - Arguments for method DescribeDBClusterBacktracks on L<Paws::RDS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeDBClusterBacktracks on the | ||
| 26 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeDBClusterBacktracks. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusterBacktracks. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('RDS'); | ||
| 34 | my $DBClusterBacktrackMessage = $rds->DescribeDBClusterBacktracks( | ||
| 35 | DBClusterIdentifier => 'MyString', | ||
| 36 | BacktrackIdentifier => 'MyString', # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', | ||
| 40 | Values => [ 'MyString', ... ], | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | Marker => 'MyString', # OPTIONAL | ||
| 46 | MaxRecords => 1, # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $DBClusterBacktracks = $DBClusterBacktrackMessage->DBClusterBacktracks; | ||
| 51 | my $Marker = $DBClusterBacktrackMessage->Marker; | ||
| 52 | |||
| 53 | # Returns a L<Paws::RDS::DBClusterBacktrackMessage> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusterBacktracks> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 BacktrackIdentifier => Str | ||
| 62 | |||
| 63 | If specified, this value is the backtrack identifier of the backtrack | ||
| 64 | to be described. | ||
| 65 | |||
| 66 | Constraints: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Must contain a valid universally unique identifier (UUID). For more | ||
| 73 | information about UUIDs, see A Universally Unique Identifier (UUID) URN | ||
| 74 | Namespace (http://www.ietf.org/rfc/rfc4122.txt). | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | Example: C<123e4567-e89b-12d3-a456-426655440000> | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 83 | |||
| 84 | The DB cluster identifier of the DB cluster to be described. This | ||
| 85 | parameter is stored as a lowercase string. | ||
| 86 | |||
| 87 | Constraints: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Must contain from 1 to 63 alphanumeric characters or hyphens. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | First character must be a letter. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | Example: C<my-cluster1> | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 110 | |||
| 111 | A filter that specifies one or more DB clusters to describe. Supported | ||
| 112 | filters include the following: | ||
| 113 | |||
| 114 | =over | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<db-cluster-backtrack-id> - Accepts backtrack identifiers. The results | ||
| 119 | list includes information about only the backtracks identified by these | ||
| 120 | identifiers. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<db-cluster-backtrack-status> - Accepts any of the following backtrack | ||
| 125 | status values: | ||
| 126 | |||
| 127 | =over | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<applying> | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | C<completed> | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<failed> | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<pending> | ||
| 144 | |||
| 145 | =back | ||
| 146 | |||
| 147 | The results list includes information about only the backtracks | ||
| 148 | identified by these values. | ||
| 149 | |||
| 150 | =back | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 Marker => Str | ||
| 156 | |||
| 157 | An optional pagination token provided by a previous | ||
| 158 | C<DescribeDBClusterBacktracks> request. If this parameter is specified, | ||
| 159 | the response includes only records beyond the marker, up to the value | ||
| 160 | specified by C<MaxRecords>. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 MaxRecords => Int | ||
| 165 | |||
| 166 | The maximum number of records to include in the response. If more | ||
| 167 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 168 | token called a marker is included in the response so you can retrieve | ||
| 169 | the remaining results. | ||
| 170 | |||
| 171 | Default: 100 | ||
| 172 | |||
| 173 | Constraints: Minimum 20, maximum 100. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head1 SEE ALSO | ||
| 179 | |||
| 180 | This class forms part of L<Paws>, documenting arguments for method DescribeDBClusterBacktracks in L<Paws::RDS> | ||
| 181 | |||
| 182 | =head1 BUGS and CONTRIBUTIONS | ||
| 183 | |||
| 184 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 185 | |||
| 186 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 187 | |||
| 188 | =cut | ||
| 189 |