NAME

Paws::ApiGatewayV2::Route

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::Route object:

  $service_obj->Method(Att1 => { ApiKeyRequired => $value, ..., Target => $value  });

Results returned from an API call

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

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

DESCRIPTION

Represents a route.

ATTRIBUTES

ApiKeyRequired => Bool

  Specifies whether an API key is required for this route.

AuthorizationScopes => ArrayRef[Str|Undef]

  A list of authorization scopes configured on a route. The scopes are
used with a COGNITO_USER_POOLS authorizer to authorize the method
invocation. The authorization works by matching the route scopes
against the scopes parsed from the access token in the incoming
request. The method invocation is authorized if any route scope matches
a claimed scope in the access token. Otherwise, the invocation is not
authorized. When the route scope is configured, the client must provide
an access token instead of an identity token for authorization
purposes.

AuthorizationType => Str

  The authorization type for the route. Valid values are NONE for open
access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a
Lambda authorizer

AuthorizerId => Str

  The identifier of the Authorizer resource to be associated with this
route, if the authorizationType is CUSTOM . The authorizer identifier
is generated by API Gateway when you created the authorizer.

ModelSelectionExpression => Str

  The model selection expression for the route.

OperationName => Str

  The operation name for the route.

RequestModels => Paws::ApiGatewayV2::RouteModels

  The request models for the route.

RequestParameters => Paws::ApiGatewayV2::RouteParameters

  The request parameters for the route.

RouteId => Str

  The route ID.

REQUIRED RouteKey => Str

  The route key for the route.

RouteResponseSelectionExpression => Str

  The route response selection expression for the route.

Target => Str

  The target for the route.

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