/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGatewayV2::CreateRoute

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $apigateway = Paws->service('ApiGatewayV2');
my $CreateRouteResponseShape = $apigateway->CreateRoute(
  ApiId               => 'My__string',
  RouteKey            => 'MySelectionKey',
  ApiKeyRequired      => 1,                        # OPTIONAL
  AuthorizationScopes => [ 'MyStringWithLengthBetween1And64', ... ]
  ,                                                # OPTIONAL
  AuthorizationType        => 'NONE',                             # OPTIONAL
  AuthorizerId             => 'MyId',                             # OPTIONAL
  ModelSelectionExpression => 'MySelectionExpression',            # OPTIONAL
  OperationName            => 'MyStringWithLengthBetween1And64',  # OPTIONAL
  RequestModels => { 'My__string' => 'MyStringWithLengthBetween1And128', }
  ,                                                               # OPTIONAL
  RequestParameters => { 'My__string' => { Required => 1, }, },   # OPTIONAL
  RouteResponseSelectionExpression => 'MySelectionExpression',    # OPTIONAL
  Target => 'MyStringWithLengthBetween1And128',                   # OPTIONAL
);

# Results:
my $ApiGatewayManaged   = $CreateRouteResponseShape->ApiGatewayManaged;
my $ApiKeyRequired      = $CreateRouteResponseShape->ApiKeyRequired;
my $AuthorizationScopes = $CreateRouteResponseShape->AuthorizationScopes;
my $AuthorizationType   = $CreateRouteResponseShape->AuthorizationType;
my $AuthorizerId        = $CreateRouteResponseShape->AuthorizerId;
my $ModelSelectionExpression =
  $CreateRouteResponseShape->ModelSelectionExpression;
my $OperationName     = $CreateRouteResponseShape->OperationName;
my $RequestModels     = $CreateRouteResponseShape->RequestModels;
my $RequestParameters = $CreateRouteResponseShape->RequestParameters;
my $RouteId           = $CreateRouteResponseShape->RouteId;
my $RouteKey          = $CreateRouteResponseShape->RouteKey;
my $RouteResponseSelectionExpression =
  $CreateRouteResponseShape->RouteResponseSelectionExpression;
my $Target = $CreateRouteResponseShape->Target;

# Returns a L<Paws::ApiGatewayV2::CreateRouteResponseShape> 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/CreateRoute

ATTRIBUTES

REQUIRED ApiId => Str

The API identifier.

ApiKeyRequired => Bool

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

AuthorizationScopes => ArrayRef[Str|Undef]

The authorization scopes supported by this route.

AuthorizationType => Str

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Valid values are: "NONE", "AWS_IAM", "CUSTOM", "JWT"

AuthorizerId => Str

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

ModelSelectionExpression => Str

The model selection expression for the route. Supported only for WebSocket APIs.

OperationName => Str

The operation name for the route.

RequestModels => Paws::ApiGatewayV2::RouteModels

The request models for the route. Supported only for WebSocket APIs.

RequestParameters => Paws::ApiGatewayV2::RouteParameters

The request parameters for the route. Supported only for WebSocket APIs.

REQUIRED RouteKey => Str

The route key for the route.

RouteResponseSelectionExpression => Str

The route response selection expression for the route. Supported only for WebSocket APIs.

Target => Str

The target for the route.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateRoute 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