CfnApi

class aws_cdk.aws_apigatewayv2.CfnApi(scope, id, *, 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: CfnResource

The AWS::ApiGatewayV2::Api resource creates an API.

WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html
CloudformationResource:: AWS::ApiGatewayV2::Api
ExampleMetadata:: fixture=_generated

Example:

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

# body: Any

cfn_api = apigatewayv2.CfnApi(self, "MyCfnApi",
    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"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ApiGatewayV2::Api'

api_key_selection_expression: An API key selection expression.

attr_api_endpoint

The default endpoint for an API.

For example: https://abcdef.execute-api.us-west-2.amazonaws.com .

CloudformationAttribute:: ApiEndpoint

attr_api_id

The API identifier.

CloudformationAttribute:: ApiId

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

body: The OpenAPI definition.

body_s3_location: The S3 location of an OpenAPI definition.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

cors_configuration: A CORS configuration.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

credentials_arn: This property is part of quick create.

description: The description of the API.

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

disable_schema_validation: Avoid validating models when creating a deployment.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the API.

node: The tree node.

protocol_type: The API protocol.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

route_key: This property is part of quick create.

route_selection_expression: The route selection expression for the API.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The collection of tags.

target: This property is part of quick create.

version: A version identifier for the API.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

BodyS3LocationProperty

class CfnApi.BodyS3LocationProperty(*, bucket=None, etag=None, key=None, version=None)

Bases: object

The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.

Parameters:

bucket (Optional[str]) – The S3 bucket that contains the OpenAPI definition to import. Required if you specify a BodyS3Location for an API.
etag (Optional[str]) – The Etag of the S3 object.
key (Optional[str]) – The key of the S3 object. Required if you specify a BodyS3Location for an API.
version (Optional[str]) – The version of the S3 object.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

body_s3_location_property = apigatewayv2.CfnApi.BodyS3LocationProperty(
    bucket="bucket",
    etag="etag",
    key="key",
    version="version"
)

Attributes

bucket

The S3 bucket that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket

etag

The Etag of the S3 object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag

key

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key

version

The version of the S3 object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version

CorsProperty

class CfnApi.CorsProperty(*, allow_credentials=None, allow_headers=None, allow_methods=None, allow_origins=None, expose_headers=None, max_age=None)

Bases: object

The Cors property specifies a CORS configuration for an API.

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

Parameters:

allow_credentials (Union[bool, IResolvable, None]) – Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
allow_headers (Optional[Sequence[str]]) – Represents a collection of allowed headers. Supported only for HTTP APIs.
allow_methods (Optional[Sequence[str]]) – Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
allow_origins (Optional[Sequence[str]]) – Represents a collection of allowed origins. Supported only for HTTP APIs.
expose_headers (Optional[Sequence[str]]) – Represents a collection of exposed headers. Supported only for HTTP APIs.
max_age (Union[int, float, None]) – The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cors_property = apigatewayv2.CfnApi.CorsProperty(
    allow_credentials=False,
    allow_headers=["allowHeaders"],
    allow_methods=["allowMethods"],
    allow_origins=["allowOrigins"],
    expose_headers=["exposeHeaders"],
    max_age=123
)