GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ApiGatewayV2::CreateStage(3) User Contributed Perl Documentation Paws::ApiGatewayV2::CreateStage(3)

Paws::ApiGatewayV2::CreateStage - Arguments for method CreateStage on Paws::ApiGatewayV2

This class represents the parameters used for calling the method CreateStage on the AmazonApiGatewayV2 service. Use the attributes of this class as arguments to method CreateStage.

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

    my $apigateway = Paws->service('ApiGatewayV2');
    my $CreateStageResponse = $apigateway->CreateStage(
      ApiId             => 'My__string',
      StageName         => 'MyStringWithLengthBetween1And128',
      AccessLogSettings => {
        DestinationArn => 'MyArn',                                # OPTIONAL
        Format         => 'MyStringWithLengthBetween1And1024',    # OPTIONAL
      },    # OPTIONAL
      AutoDeploy           => 1,         # OPTIONAL
      ClientCertificateId  => 'MyId',    # OPTIONAL
      DefaultRouteSettings => {
        DataTraceEnabled       => 1,
        DetailedMetricsEnabled => 1,
        LoggingLevel           => 'ERROR',  # values: ERROR, INFO, OFF; OPTIONAL
        ThrottlingBurstLimit   => 1,        # OPTIONAL
        ThrottlingRateLimit    => 1,        # OPTIONAL
      },    # OPTIONAL
      DeploymentId  => 'MyId',                                 # OPTIONAL
      Description   => 'MyStringWithLengthBetween0And1024',    # OPTIONAL
      RouteSettings => {
        'My__string' => {
          DataTraceEnabled       => 1,
          DetailedMetricsEnabled => 1,
          LoggingLevel         => 'ERROR',  # values: ERROR, INFO, OFF; OPTIONAL
          ThrottlingBurstLimit => 1,        # OPTIONAL
          ThrottlingRateLimit  => 1,        # OPTIONAL
        },
      },    # OPTIONAL
      StageVariables =>
        { 'My__string' => 'MyStringWithLengthBetween0And2048', },    # OPTIONAL
      Tags => { 'My__string' => 'MyStringWithLengthBetween1And1600', }
      ,                                                              # OPTIONAL
    );
    # Results:
    my $AccessLogSettings    = $CreateStageResponse->AccessLogSettings;
    my $ApiGatewayManaged    = $CreateStageResponse->ApiGatewayManaged;
    my $AutoDeploy           = $CreateStageResponse->AutoDeploy;
    my $ClientCertificateId  = $CreateStageResponse->ClientCertificateId;
    my $CreatedDate          = $CreateStageResponse->CreatedDate;
    my $DefaultRouteSettings = $CreateStageResponse->DefaultRouteSettings;
    my $DeploymentId         = $CreateStageResponse->DeploymentId;
    my $Description          = $CreateStageResponse->Description;
    my $LastDeploymentStatusMessage =
      $CreateStageResponse->LastDeploymentStatusMessage;
    my $LastUpdatedDate = $CreateStageResponse->LastUpdatedDate;
    my $RouteSettings   = $CreateStageResponse->RouteSettings;
    my $StageName       = $CreateStageResponse->StageName;
    my $StageVariables  = $CreateStageResponse->StageVariables;
    my $Tags            = $CreateStageResponse->Tags;
    # Returns a L<Paws::ApiGatewayV2::CreateStageResponse> 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/CreateStage>

Settings for logging access in this stage.

REQUIRED ApiId => Str

The API identifier.

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

The default route settings for the stage.

The deployment identifier of the API stage.

The description for the API stage.

Route settings for the stage, by routeKey.

REQUIRED StageName => Str

The name of the stage.

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

The collection of tags. Each tag element is associated with a given resource.

This class forms part of Paws, documenting arguments for method CreateStage in Paws::ApiGatewayV2

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.