CfnApiProps

class aws_cdk.aws_apigatewayv2.CfnApiProps(*, api_key_selection_expression=None, base_path=None, body=None, body_s3_location=None, cors_configuration=None, credentials_arn=None, description=None, disable_execute_api_endpoint=None, disable_schema_validation=None, fail_on_warnings=None, name=None, protocol_type=None, route_key=None, route_selection_expression=None, tags=None, target=None, version=None)

Bases: object

Properties for defining a CfnApi.

Parameters:

api_key_selection_expression (Optional[str]) – An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
base_path (Optional[str]) – Specifies how to interpret the base path of the API during import. Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.
body (Optional[Any]) – The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don’t specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn’t support the combination of OpenAPI and CloudFormation resources.
body_s3_location (Union[IResolvable, BodyS3LocationProperty, Dict[str, Any], None]) – The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don’t specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn’t support the combination of OpenAPI and CloudFormation resources.
cors_configuration (Union[IResolvable, CorsProperty, Dict[str, Any], None]) – A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
credentials_arn (Optional[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 (Optional[str]) – The description of the API.
disable_execute_api_endpoint (Union[bool, IResolvable, None]) – Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disable_schema_validation (Union[bool, IResolvable, None]) – Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
fail_on_warnings (Union[bool, IResolvable, None]) – Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
name (Optional[str]) – The name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
protocol_type (Optional[str]) – The API protocol. Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
route_key (Optional[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.
route_selection_expression (Optional[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 (Optional[Mapping[str, str]]) – The collection of tags. Each tag element is associated with a given resource.
target (Optional[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 (Optional[str]) – A version identifier for the API.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# body: Any

cfn_api_props = apigatewayv2.CfnApiProps(
    api_key_selection_expression="apiKeySelectionExpression",
    base_path="basePath",
    body=body,
    body_s3_location=apigatewayv2.CfnApi.BodyS3LocationProperty(
        bucket="bucket",
        etag="etag",
        key="key",
        version="version"
    ),
    cors_configuration=apigatewayv2.CfnApi.CorsProperty(
        allow_credentials=False,
        allow_headers=["allowHeaders"],
        allow_methods=["allowMethods"],
        allow_origins=["allowOrigins"],
        expose_headers=["exposeHeaders"],
        max_age=123
    ),
    credentials_arn="credentialsArn",
    description="description",
    disable_execute_api_endpoint=False,
    disable_schema_validation=False,
    fail_on_warnings=False,
    name="name",
    protocol_type="protocolType",
    route_key="routeKey",
    route_selection_expression="routeSelectionExpression",
    tags={
        "tags_key": "tags"
    },
    target="target",
    version="version"
)

Attributes

api_key_selection_expression

An API key selection expression.

Supported only for WebSocket APIs. See API Key Selection Expressions .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

base_path

Specifies how to interpret the base path of the API during import.

Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

body

The OpenAPI definition.

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don’t specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn’t support the combination of OpenAPI and CloudFormation resources.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

body_s3_location

The S3 location of an OpenAPI definition.

Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don’t specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn’t support the combination of OpenAPI and CloudFormation resources.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

cors_configuration

A CORS configuration.

Supported only for HTTP APIs. See Configuring CORS for more information.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

credentials_arn

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

description

The description of the API.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

disable_execute_api_endpoint

Specifies whether clients can invoke your API by using the default execute-api endpoint.

By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint

disable_schema_validation

Avoid validating models when creating a deployment.

Supported only for WebSocket APIs.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

fail_on_warnings

Specifies whether to rollback the API creation when a warning is encountered.

By default, API creation continues if a warning is encountered.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

name

The name of the API.

Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

protocol_type

The API protocol.

Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

route_key

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

route_selection_expression

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

tags

The collection of tags.

Each tag element is associated with a given resource.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags

target

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.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

version

A version identifier for the API.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version