NAME
Paws::ApiGatewayV2::CreateApiInput
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::CreateApiInput object:
$service_obj->Method(Att1 => { ApiKeySelectionExpression => $value, ..., Version => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::CreateApiInput object:
$result = $service_obj->Method(...);
$result->Att1->ApiKeySelectionExpressionDESCRIPTION
Represents the input parameters for a CreateApi request.
ATTRIBUTES
ApiKeySelectionExpression => Str
An API key selection expression. Supported only for WebSocket APIs. 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).CorsConfiguration => Paws::ApiGatewayV2::Cors
A CORS configuration. Supported only for HTTP APIs. See Configuring
CORS
(https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)
for more information.CredentialsArn => Str
This property is part of quick create. It specifies the credentials
required for the integration, if any. For a Lambda integration, three
options are available. To specify an IAM Role for API Gateway to
assume, use the role's Amazon Resource Name (ARN). To require that the
caller's identity be passed through from the request, specify
arn:aws:iam::*:user/*. To use resource-based permissions on supported
AWS services, specify null. Currently, this property is not used for
HTTP integrations. Supported only for HTTP APIs.Description => Str
The description of the API.DisableSchemaValidation => Bool
Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.REQUIRED Name => Str
The name of the API.REQUIRED ProtocolType => Str
The API protocol.RouteKey => Str
This property is part of quick create. If you don't specify a routeKey,
a default route of $default is created. The $default route acts as a
catch-all for any request made to your API, for a particular stage. The
$default route key can't be modified. You can add routes after creating
the API, and you can update the route keys of additional routes.
Supported only for HTTP APIs.RouteSelectionExpression => Str
The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.Tags => Paws::ApiGatewayV2::Tags
The collection of tags. Each tag element is associated with a given
resource.Target => Str
This property is part of quick create. Quick create produces an API
with an integration, a default catch-all route, and a default stage
which is configured to automatically deploy changes. For HTTP
integrations, specify a fully qualified URL. For Lambda integrations,
specify a function ARN. The type of the integration will be HTTP_PROXY
or AWS_PROXY, respectively. Supported only for HTTP APIs.Version => Str
A version identifier for the API.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