CPAN Security Tip #1/3: Add a SECURITY.md policy to your favorite CPAN dists! Learn more

BYTEROCK / Paws-0.43 / lib / Paws / DocDB / DescribeOrderableDBInstanceOptions.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
—
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

              
package Paws::DocDB::DescribeOrderableDBInstanceOptions;
  use Moose;
  has DBInstanceClass => (is => 'ro', isa => 'Str');
  has Engine => (is => 'ro', isa => 'Str', required => 1);
  has EngineVersion => (is => 'ro', isa => 'Str');
  has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]');
  has LicenseModel => (is => 'ro', isa => 'Str');
  has Marker => (is => 'ro', isa => 'Str');
  has MaxRecords => (is => 'ro', isa => 'Int');
  has Vpc => (is => 'ro', isa => 'Bool');
  use MooseX::ClassAttribute;
  class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptions');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::OrderableDBInstanceOptionsMessage');
  class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeOrderableDBInstanceOptionsResult');
1;
### main pod documentation begin ###
=head1 NAME
Paws::DocDB::DescribeOrderableDBInstanceOptions - Arguments for method DescribeOrderableDBInstanceOptions on L<Paws::DocDB>
=head1 DESCRIPTION
This class represents the parameters used for calling the method DescribeOrderableDBInstanceOptions on the
L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class
as arguments to method DescribeOrderableDBInstanceOptions.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeOrderableDBInstanceOptions.
=head1 SYNOPSIS
    my $rds = Paws->service('DocDB');
    my $OrderableDBInstanceOptionsMessage =
      $rds->DescribeOrderableDBInstanceOptions(
      Engine          => 'MyString',
      DBInstanceClass => 'MyString',    # OPTIONAL
      EngineVersion   => 'MyString',    # OPTIONAL
      Filters         => [
        {
          Name   => 'MyString',
          Values => [ 'MyString', ... ],
        },
        ...
      ],                                # OPTIONAL
      LicenseModel => 'MyString',       # OPTIONAL
      Marker       => 'MyString',       # OPTIONAL
      MaxRecords   => 1,                # OPTIONAL
      Vpc          => 1,                # OPTIONAL
      );
    # Results:
    my $Marker = $OrderableDBInstanceOptionsMessage->Marker;
    my $OrderableDBInstanceOptions =
      $OrderableDBInstanceOptionsMessage->OrderableDBInstanceOptions;
    # Returns a L<Paws::DocDB::OrderableDBInstanceOptionsMessage> object.
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.
For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeOrderableDBInstanceOptions>
=head1 ATTRIBUTES
=head2 DBInstanceClass => Str
The instance class filter value. Specify this parameter to show only
the available offerings that match the specified instance class.
=head2 B<REQUIRED> Engine => Str
The name of the engine to retrieve instance options for.
=head2 EngineVersion => Str
The engine version filter value. Specify this parameter to show only
the available offerings that match the specified engine version.
=head2 Filters => ArrayRef[L<Paws::DocDB::Filter>]
This parameter is not currently supported.
=head2 LicenseModel => Str
The license model filter value. Specify this parameter to show only the
available offerings that match the specified license model.
=head2 Marker => Str
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by C<MaxRecords>.
=head2 MaxRecords => Int
The maximum number of records to include in the response. If more
records exist than the specified C<MaxRecords> value, a pagination
token (marker) is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
=head2 Vpc => Bool
The virtual private cloud (VPC) filter value. Specify this parameter to
show only the available VPC or non-VPC offerings.
=head1 SEE ALSO
This class forms part of L<Paws>, documenting arguments for method DescribeOrderableDBInstanceOptions in L<Paws::DocDB>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut