CfnApiMappingProps

class aws_cdk.aws_apigatewayv2.CfnApiMappingProps(*, api_id, domain_name, stage, api_mapping_key=None)

Bases: object

Properties for defining a CfnApiMapping.

Parameters
  • api_id (str) – The identifier of the API.

  • domain_name (str) – The domain name.

  • stage (str) – The API stage.

  • api_mapping_key (Optional[str]) – The API mapping key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.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

cfn_api_mapping_props = apigatewayv2.CfnApiMappingProps(
    api_id="apiId",
    domain_name="domainName",
    stage="stage",

    # the properties below are optional
    api_mapping_key="apiMappingKey"
)

Attributes

api_id

The identifier of the API.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid

Return type

str

api_mapping_key

The API mapping key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey

Return type

Optional[str]

domain_name

The domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname

Return type

str

stage

The API stage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage

Return type

str