| 1 | |||
| 2 | package Paws::RDS::DescribeDBInstanceAutomatedBackups; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceAutomatedBackupsArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has DbiResourceId => (is => 'ro', isa => 'Str'); | ||
| 7 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | ||
| 8 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 9 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBInstanceAutomatedBackups'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBInstanceAutomatedBackupMessage'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBInstanceAutomatedBackupsResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RDS::DescribeDBInstanceAutomatedBackups - Arguments for method DescribeDBInstanceAutomatedBackups on L<Paws::RDS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeDBInstanceAutomatedBackups on the | ||
| 27 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeDBInstanceAutomatedBackups. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstanceAutomatedBackups. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $rds = Paws->service('RDS'); | ||
| 35 | my $DBInstanceAutomatedBackupMessage = | ||
| 36 | $rds->DescribeDBInstanceAutomatedBackups( | ||
| 37 | DBInstanceAutomatedBackupsArn => 'MyString', # OPTIONAL | ||
| 38 | DBInstanceIdentifier => 'MyString', # OPTIONAL | ||
| 39 | DbiResourceId => 'MyString', # OPTIONAL | ||
| 40 | Filters => [ | ||
| 41 | { | ||
| 42 | Name => 'MyString', | ||
| 43 | Values => [ 'MyString', ... ], | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | Marker => 'MyString', # OPTIONAL | ||
| 49 | MaxRecords => 1, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $DBInstanceAutomatedBackups = | ||
| 54 | $DBInstanceAutomatedBackupMessage->DBInstanceAutomatedBackups; | ||
| 55 | my $Marker = $DBInstanceAutomatedBackupMessage->Marker; | ||
| 56 | |||
| 57 | # Returns a L<Paws::RDS::DBInstanceAutomatedBackupMessage> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBInstanceAutomatedBackups> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DBInstanceAutomatedBackupsArn => Str | ||
| 66 | |||
| 67 | The Amazon Resource Name (ARN) of the replicated automated backups, for | ||
| 68 | example, | ||
| 69 | C<arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE>. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 DBInstanceIdentifier => Str | ||
| 74 | |||
| 75 | (Optional) The user-supplied instance identifier. If this parameter is | ||
| 76 | specified, it must match the identifier of an existing DB instance. It | ||
| 77 | returns information from the specific DB instance' automated backup. | ||
| 78 | This parameter isn't case-sensitive. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 DbiResourceId => Str | ||
| 83 | |||
| 84 | The resource ID of the DB instance that is the source of the automated | ||
| 85 | backup. This parameter isn't case-sensitive. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 90 | |||
| 91 | A filter that specifies which resources to return based on status. | ||
| 92 | |||
| 93 | Supported filters are the following: | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<status> | ||
| 100 | |||
| 101 | =over | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<active> - automated backups for current instances | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<retained> - automated backups for deleted instances and after backup | ||
| 110 | replication is stopped | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<creating> - automated backups that are waiting for the first | ||
| 115 | automated snapshot to be available | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<db-instance-id> - Accepts DB instance identifiers and Amazon Resource | ||
| 122 | Names (ARNs). The results list includes only information about the DB | ||
| 123 | instance automated backups identified by these ARNs. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<dbi-resource-id> - Accepts DB resource identifiers and Amazon | ||
| 128 | Resource Names (ARNs). The results list includes only information about | ||
| 129 | the DB instance resources identified by these ARNs. | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | Returns all resources by default. The status for each resource is | ||
| 134 | specified in the response. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 Marker => Str | ||
| 139 | |||
| 140 | The pagination token provided in the previous request. If this | ||
| 141 | parameter is specified the response includes only records beyond the | ||
| 142 | marker, up to C<MaxRecords>. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 MaxRecords => Int | ||
| 147 | |||
| 148 | The maximum number of records to include in the response. If more | ||
| 149 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 150 | token called a marker is included in the response so that you can | ||
| 151 | retrieve the remaining results. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, documenting arguments for method DescribeDBInstanceAutomatedBackups in L<Paws::RDS> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |