NAME

Paws::ApiGateway::CreateUsagePlan - Arguments for method CreateUsagePlan on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method CreateUsagePlan on the Amazon API Gateway service. Use the attributes of this class as arguments to method CreateUsagePlan.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUsagePlan.

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $UsagePlan = $apigateway->CreateUsagePlan(
      Name      => 'MyString',
      ApiStages => [
        {
          ApiId    => 'MyString',
          Stage    => 'MyString',
          Throttle => {
            'MyString' => {
              BurstLimit => 1,    # OPTIONAL
              RateLimit  => 1,    # OPTIONAL
            },
          },    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Description => 'MyString',    # OPTIONAL
      Quota       => {
        Limit  => 1,                # OPTIONAL
        Offset => 1,                # OPTIONAL
        Period => 'DAY',            # values: DAY, WEEK, MONTH; OPTIONAL
      },    # OPTIONAL
      Tags     => { 'MyString' => 'MyString', },    # OPTIONAL
      Throttle => {
        BurstLimit => 1,                            # OPTIONAL
        RateLimit  => 1,                            # OPTIONAL
      },    # OPTIONAL
    );

    # Results:
    my $ApiStages   = $UsagePlan->ApiStages;
    my $Description = $UsagePlan->Description;
    my $Id          = $UsagePlan->Id;
    my $Name        = $UsagePlan->Name;
    my $ProductCode = $UsagePlan->ProductCode;
    my $Quota       = $UsagePlan->Quota;
    my $Tags        = $UsagePlan->Tags;
    my $Throttle    = $UsagePlan->Throttle;

    # Returns a L<Paws::ApiGateway::UsagePlan> 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 https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateUsagePlan

ATTRIBUTES

ApiStages => ArrayRef[Paws::ApiGateway::ApiStage]

The associated API stages of the usage plan.

Description => Str

The description of the usage plan.

REQUIRED Name => Str

[Required] The name of the usage plan.

Quota => Paws::ApiGateway::QuotaSettings

The quota of the usage plan.

Tags => Paws::ApiGateway::MapOfStringToString

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Throttle => Paws::ApiGateway::ThrottleSettings

The throttling limits of the usage plan.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateUsagePlan in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues