/ 
Paws-0.39
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGatewayV2::CreateApi

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $apigateway = Paws->service('ApiGatewayV2');
my $CreateApiResponse = $apigateway->CreateApi(
  Name                      => 'MyStringWithLengthBetween1And128',
  ProtocolType              => 'WEBSOCKET',
  RouteSelectionExpression  => 'MySelectionExpression',
  ApiKeySelectionExpression => 'MySelectionExpression',           # OPTIONAL
  Description             => 'MyStringWithLengthBetween0And1024', # OPTIONAL
  DisableSchemaValidation => 1,                                   # OPTIONAL
  Version                 => 'MyStringWithLengthBetween1And64',   # OPTIONAL
);

# Results:
my $ApiEndpoint = $CreateApiResponse->ApiEndpoint;
my $ApiId       = $CreateApiResponse->ApiId;
my $ApiKeySelectionExpression =
  $CreateApiResponse->ApiKeySelectionExpression;
my $CreatedDate              = $CreateApiResponse->CreatedDate;
my $Description              = $CreateApiResponse->Description;
my $DisableSchemaValidation  = $CreateApiResponse->DisableSchemaValidation;
my $Name                     = $CreateApiResponse->Name;
my $ProtocolType             = $CreateApiResponse->ProtocolType;
my $RouteSelectionExpression = $CreateApiResponse->RouteSelectionExpression;
my $Version                  = $CreateApiResponse->Version;
my $Warnings                 = $CreateApiResponse->Warnings;

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

ATTRIBUTES

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).

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.

Valid values are: "WEBSOCKET"

REQUIRED RouteSelectionExpression => Str

The route selection expression for the API.

Version => Str

A version identifier for the API.

SEE ALSO

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