create-api-mapping¶

Description¶

Creates an API mapping.

Synopsis¶

  create-api-mapping
--api-id <value>
[--api-mapping-key <value>]
--domain-name <value>
--stage <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--api-id (string)

The API identifier.

--api-mapping-key (string) The API mapping key.

--domain-name (string)

The domain name.

--stage (string)

The API stage.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create an API mapping for an API

The following create-api-mapping example maps the test stage of an API to the /myApi path of the regional.example.com custom domain name.

aws apigatewayv2 create-api-mapping \
    --domain-name regional.example.com \
    --api-mapping-key myApi \
    --api-id a1b2c3d4 \
    --stage test

Output:

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "myApi"
    "Stage": "test"
}

For more information, see Setting up a regional custom domain name in API Gateway in the Amazon API Gateway Developer Guide.

Output¶

ApiId -> (string)

The API identifier.

ApiMappingId -> (string)

The API mapping identifier.

ApiMappingKey -> (string)

The API mapping key.

Stage -> (string)