« blib/lib/Paws/ApiGateway/CreateStage.pm
↑ Summary
blib/lib/Paws/ApiGateway/CreateUsagePlanKey.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::CreateUsagePlan; | ||
| 3 | use Moose; | ||
| 4 | has ApiStages => (is => 'ro', isa => 'ArrayRef[Paws::ApiGateway::ApiStage]', traits => ['NameInRequest'], request_name => 'apiStages'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 7 | has Quota => (is => 'ro', isa => 'Paws::ApiGateway::QuotaSettings', traits => ['NameInRequest'], request_name => 'quota'); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 9 | has Throttle => (is => 'ro', isa => 'Paws::ApiGateway::ThrottleSettings', traits => ['NameInRequest'], request_name => 'throttle'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUsagePlan'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/usageplans'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::UsagePlan'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ApiGateway::CreateUsagePlan - Arguments for method CreateUsagePlan on L<Paws::ApiGateway> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateUsagePlan on the | ||
| 28 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateUsagePlan. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUsagePlan. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $apigateway = Paws->service('ApiGateway'); | ||
| 36 | my $UsagePlan = $apigateway->CreateUsagePlan( | ||
| 37 | Name => 'MyString', | ||
| 38 | ApiStages => [ | ||
| 39 | { | ||
| 40 | ApiId => 'MyString', | ||
| 41 | Stage => 'MyString', | ||
| 42 | Throttle => { | ||
| 43 | 'MyString' => { | ||
| 44 | BurstLimit => 1, # OPTIONAL | ||
| 45 | RateLimit => 1, # OPTIONAL | ||
| 46 | }, | ||
| 47 | }, # OPTIONAL | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | Description => 'MyString', # OPTIONAL | ||
| 52 | Quota => { | ||
| 53 | Limit => 1, # OPTIONAL | ||
| 54 | Offset => 1, # OPTIONAL | ||
| 55 | Period => 'DAY', # values: DAY, WEEK, MONTH; OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | Tags => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 58 | Throttle => { | ||
| 59 | BurstLimit => 1, # OPTIONAL | ||
| 60 | RateLimit => 1, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | # Results: | ||
| 65 | my $ApiStages = $UsagePlan->ApiStages; | ||
| 66 | my $Description = $UsagePlan->Description; | ||
| 67 | my $Id = $UsagePlan->Id; | ||
| 68 | my $Name = $UsagePlan->Name; | ||
| 69 | my $ProductCode = $UsagePlan->ProductCode; | ||
| 70 | my $Quota = $UsagePlan->Quota; | ||
| 71 | my $Tags = $UsagePlan->Tags; | ||
| 72 | my $Throttle = $UsagePlan->Throttle; | ||
| 73 | |||
| 74 | # Returns a L<Paws::ApiGateway::UsagePlan> object. | ||
| 75 | |||
| 76 | 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. | ||
| 77 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateUsagePlan> | ||
| 78 | |||
| 79 | =head1 ATTRIBUTES | ||
| 80 | |||
| 81 | |||
| 82 | =head2 ApiStages => ArrayRef[L<Paws::ApiGateway::ApiStage>] | ||
| 83 | |||
| 84 | The associated API stages of the usage plan. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Description => Str | ||
| 89 | |||
| 90 | The description of the usage plan. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> Name => Str | ||
| 95 | |||
| 96 | [Required] The name of the usage plan. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Quota => L<Paws::ApiGateway::QuotaSettings> | ||
| 101 | |||
| 102 | The quota of the usage plan. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 107 | |||
| 108 | The key-value map of strings. The valid character set is | ||
| 109 | [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not | ||
| 110 | start with C<aws:>. The tag value can be up to 256 characters. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 Throttle => L<Paws::ApiGateway::ThrottleSettings> | ||
| 115 | |||
| 116 | The throttling limits of the usage plan. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateUsagePlan in L<Paws::ApiGateway> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |