« blib/lib/Paws/RDS/DescribeReservedDBInstances.pm
↑ Summary
blib/lib/Paws/RDS/DomainMembership.pm »
| 1 | |||
| 2 | package Paws::RDS::DescribeReservedDBInstancesOfferings; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has Duration => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]'); | |
| 7 | 1 | has Marker => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has MaxRecords => (is => 'ro', isa => 'Int'); | |
| 9 | 1 | has MultiAZ => (is => 'ro', isa => 'Bool'); | |
| 10 | 1 | has OfferingType => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has ProductDescription => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has ReservedDBInstancesOfferingId => (is => 'ro', isa => 'Str'); | |
| 13 | |||
| 14 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | |||
| 16 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedDBInstancesOfferings'); | |
| 17 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ReservedDBInstancesOfferingMessage'); | |
| 18 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeReservedDBInstancesOfferingsResult'); | |
| 19 | 1 | 1; | |
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::RDS::DescribeReservedDBInstancesOfferings - Arguments for method DescribeReservedDBInstancesOfferings on L<Paws::RDS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeReservedDBInstancesOfferings on the | ||
| 30 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeReservedDBInstancesOfferings. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeReservedDBInstancesOfferings. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $rds = Paws->service('RDS'); | ||
| 38 | # To list information about reserved DB instance offerings | ||
| 39 | # This example lists information for all reserved DB instance offerings for the | ||
| 40 | # specified DB instance class, duration, product, offering type, and | ||
| 41 | # availability zone settings. | ||
| 42 | my $ReservedDBInstancesOfferingMessage = | ||
| 43 | $rds->DescribeReservedDBInstancesOfferings( | ||
| 44 | 'DBInstanceClass' => 'db.t2.micro', | ||
| 45 | 'Duration' => '1y', | ||
| 46 | 'MultiAZ' => 0, | ||
| 47 | 'OfferingType' => 'No Upfront', | ||
| 48 | 'ProductDescription' => 'mysql' | ||
| 49 | ); | ||
| 50 | |||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeReservedDBInstancesOfferings> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DBInstanceClass => Str | ||
| 59 | |||
| 60 | The DB instance class filter value. Specify this parameter to show only | ||
| 61 | the available offerings matching the specified DB instance class. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 Duration => Str | ||
| 66 | |||
| 67 | Duration filter value, specified in years or seconds. Specify this | ||
| 68 | parameter to show only reservations for this duration. | ||
| 69 | |||
| 70 | Valid Values: C<1 | 3 | 31536000 | 94608000> | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Filters => ArrayRef[L<Paws::RDS::Filter>] | ||
| 75 | |||
| 76 | This parameter isn't currently supported. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 Marker => Str | ||
| 81 | |||
| 82 | An optional pagination token provided by a previous request. If this | ||
| 83 | parameter is specified, the response includes only records beyond the | ||
| 84 | marker, up to the value specified by C<MaxRecords>. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 MaxRecords => Int | ||
| 89 | |||
| 90 | The maximum number of records to include in the response. If more than | ||
| 91 | the C<MaxRecords> value is available, a pagination token called a | ||
| 92 | marker is included in the response so you can retrieve the remaining | ||
| 93 | results. | ||
| 94 | |||
| 95 | Default: 100 | ||
| 96 | |||
| 97 | Constraints: Minimum 20, maximum 100. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 MultiAZ => Bool | ||
| 102 | |||
| 103 | A value that indicates whether to show only those reservations that | ||
| 104 | support Multi-AZ. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 OfferingType => Str | ||
| 109 | |||
| 110 | The offering type filter value. Specify this parameter to show only the | ||
| 111 | available offerings matching the specified offering type. | ||
| 112 | |||
| 113 | Valid Values: C<"Partial Upfront" | "All Upfront" | "No Upfront"> | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 ProductDescription => Str | ||
| 118 | |||
| 119 | Product description filter value. Specify this parameter to show only | ||
| 120 | the available offerings that contain the specified product description. | ||
| 121 | |||
| 122 | The results show offerings that partially match the filter value. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 ReservedDBInstancesOfferingId => Str | ||
| 127 | |||
| 128 | The offering identifier filter value. Specify this parameter to show | ||
| 129 | only the available offering that matches the specified reservation | ||
| 130 | identifier. | ||
| 131 | |||
| 132 | Example: C<438012d3-4052-4cc7-b2e3-8d3372e0e706> | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, documenting arguments for method DescribeReservedDBInstancesOfferings in L<Paws::RDS> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 | |||