The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::ApiGatewayV2::Api

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Api object:

  $service_obj->Method(Att1 => { ApiEndpoint => $value, ..., Warnings => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Api object:

  $result = $service_obj->Method(...);
  $result->Att1->ApiEndpoint

DESCRIPTION

Represents an API.

ATTRIBUTES

ApiEndpoint => Str

  The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is
typically appended to this URI to form a complete path to a deployed
API stage.

ApiId => Str

  The API ID.

ApiKeySelectionExpression => Str

  An API key selection expression. See API Key Selection Expressions
(https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).

CreatedDate => Str

  The timestamp when the API was created.

Description => Str

  The description of the API.

DisableSchemaValidation => Bool

  Avoid validating models when creating a deployment.

REQUIRED Name => Str

  The name of the API.

REQUIRED ProtocolType => Str

  The API protocol: HTTP or WEBSOCKET.

REQUIRED RouteSelectionExpression => Str

  The route selection expression for the API.

Version => Str

  A version identifier for the API.

Warnings => ArrayRef[Str|Undef]

  The warning messages reported when failonwarnings is turned on during
API import.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ApiGatewayV2

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