« blib/lib/Paws/RDS/DescribeDBEngineVersions.pm
↑ Summary
blib/lib/Paws/RDS/DescribeDBParameterGroups.pm »
| 1 | |||
| 2 | package Paws::RDS::DescribeDBInstances; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | |
| 6 | 1 | has Marker => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has MaxRecords => (is => 'ro', isa => 'Int'); | |
| 8 | |||
| 9 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBInstances'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBInstanceMessage'); | |
| 13 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBInstancesResult'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::DescribeDBInstances - Arguments for method DescribeDBInstances on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeDBInstances on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeDBInstances. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstances. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To list DB instance settings | ||
| 34 | # This example lists settings for the specified DB instance. | ||
| 35 | my $DBInstanceMessage = | ||
| 36 | $rds->DescribeDBInstances( 'DBInstanceIdentifier' => 'mymysqlinstance' ); | ||
| 37 | |||
| 38 | |||
| 39 | 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. | ||
| 40 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBInstances> | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 DBInstanceIdentifier => Str | ||
| 46 | |||
| 47 | The user-supplied instance identifier. If this parameter is specified, | ||
| 48 | information from only the specific DB instance is returned. This | ||
| 49 | parameter isn't case-sensitive. | ||
| 50 | |||
| 51 | Constraints: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | If supplied, must match the identifier of an existing DBInstance. | ||
| 58 | |||
| 59 | =back | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 65 | |||
| 66 | A filter that specifies one or more DB instances to describe. | ||
| 67 | |||
| 68 | Supported filters: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<db-cluster-id> - Accepts DB cluster identifiers and DB cluster Amazon | ||
| 75 | Resource Names (ARNs). The results list will only include information | ||
| 76 | about the DB instances associated with the DB clusters identified by | ||
| 77 | these ARNs. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<db-instance-id> - Accepts DB instance identifiers and DB instance | ||
| 82 | Amazon Resource Names (ARNs). The results list will only include | ||
| 83 | information about the DB instances identified by these ARNs. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<dbi-resource-id> - Accepts DB instance resource identifiers. The | ||
| 88 | results list will only include information about the DB instances | ||
| 89 | identified by these DB instance resource identifiers. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<domain> - Accepts Active Directory directory IDs. The results list | ||
| 94 | will only include information about the DB instances associated with | ||
| 95 | these domains. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<engine> - Accepts engine names. The results list will only include | ||
| 100 | information about the DB instances for these engines. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Marker => Str | ||
| 108 | |||
| 109 | An optional pagination token provided by a previous | ||
| 110 | C<DescribeDBInstances> request. If this parameter is specified, the | ||
| 111 | response includes only records beyond the marker, up to the value | ||
| 112 | specified by C<MaxRecords>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 MaxRecords => Int | ||
| 117 | |||
| 118 | The maximum number of records to include in the response. If more | ||
| 119 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 120 | token called a marker is included in the response so that you can | ||
| 121 | retrieve the remaining results. | ||
| 122 | |||
| 123 | Default: 100 | ||
| 124 | |||
| 125 | Constraints: Minimum 20, maximum 100. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method DescribeDBInstances in L<Paws::RDS> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 | |||