SpecRestApiProps

class aws_cdk.aws_apigateway.SpecRestApiProps(*, cloud_watch_role=None, cloud_watch_role_removal_policy=None, deploy=None, deploy_options=None, description=None, disable_execute_api_endpoint=None, domain_name=None, endpoint_configuration=None, endpoint_export_name=None, endpoint_types=None, fail_on_warnings=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None, api_definition, min_compression_size=None, mode=None)

Bases: RestApiBaseProps

Props to instantiate a new SpecRestApi.

Parameters:

  • cloud_watch_role (Optional[bool]) – Automatically configure an AWS CloudWatch role for API Gateway. Default: - false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise

  • cloud_watch_role_removal_policy (Optional[RemovalPolicy]) – The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled. Default: - RemovalPolicy.RETAIN

  • deploy (Optional[bool]) – Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: true

  • deploy_options (Union[StageOptions, Dict[str, Any], None]) – Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled. If deploy is disabled, this value cannot be set. Default: - Based on defaults of StageOptions.

  • description (Optional[str]) – A description of the RestApi construct. Default: - ‘Automatically created by the RestApi construct’

  • disable_execute_api_endpoint (Optional[bool]) – Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false

  • domain_name (Union[DomainNameOptions, Dict[str, Any], None]) – Configure a custom domain name and map it to this API. Default: - no domain name is defined, use addDomainName or directly define a DomainName.

  • endpoint_configuration (Union[EndpointConfiguration, Dict[str, Any], None]) – The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE

  • endpoint_export_name (Optional[str]) – Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export

  • endpoint_types (Optional[Sequence[EndpointType]]) – A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE

  • fail_on_warnings (Optional[bool]) – Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false

  • parameters (Optional[Mapping[str, str]]) – Custom header parameters for the request. Default: - No parameters.

  • policy (Optional[PolicyDocument]) – A policy document that contains the permissions for this RestApi. Default: - No policy.

  • rest_api_name (Optional[str]) – A name for the API Gateway RestApi resource. Default: - ID of the RestApi construct.

  • retain_deployments (Optional[bool]) – Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. Default: false

  • api_definition (ApiDefinition) – An OpenAPI definition compatible with API Gateway.

  • min_compression_size (Optional[Size]) – A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. Default: - Compression is disabled.

  • mode (Optional[RestApiMode]) – The Mode that determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, the new API definition is merged with the existing API. If you don’t specify this property, a default value is chosen: - For REST APIs created before March 29, 2021, the default is overwrite - For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it’s preferred to use API Gateway’s OpenAPI extensions to model these properties. Default: - merge for REST APIs created after March 29, 2021, otherwise overwrite

ExampleMetadata:

infused

Example:

api = apigateway.SpecRestApi(self, "books-api",
    api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json"),
    mode=apigateway.RestApiMode.MERGE
)

Attributes

api_definition

An OpenAPI definition compatible with API Gateway.

See:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html

cloud_watch_role

Automatically configure an AWS CloudWatch role for API Gateway.

Default:

  • false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise

cloud_watch_role_removal_policy

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

Requires cloudWatchRole to be enabled.

Default:

  • RemovalPolicy.RETAIN

deploy

Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

Default:

true

deploy_options

Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.

If deploy is disabled, this value cannot be set.

Default:

  • Based on defaults of StageOptions.

description

A description of the RestApi construct.

Default:

  • ‘Automatically created by the RestApi construct’

disable_execute_api_endpoint

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

To require that clients use a custom domain name to invoke the API, disable the default endpoint.

Default:

false

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

domain_name

Configure a custom domain name and map it to this API.

Default:

  • no domain name is defined, use addDomainName or directly define a DomainName.

endpoint_configuration

The EndpointConfiguration property type specifies the endpoint types of a REST API.

Default:

EndpointType.EDGE

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

endpoint_export_name

Export name for the CfnOutput containing the API endpoint.

Default:

  • when no export name is given, output will be created without export

endpoint_types

A list of the endpoint types of the API.

Use this property when creating an API.

Default:

EndpointType.EDGE

fail_on_warnings

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Default:

false

min_compression_size

A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.

When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default:

  • Compression is disabled.

mode

The Mode that determines how API Gateway handles resource updates.

Valid values are overwrite or merge.

For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.

For merge, the new API definition is merged with the existing API.

If you don’t specify this property, a default value is chosen:

  • For REST APIs created before March 29, 2021, the default is overwrite

  • For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.

Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it’s preferred to use API Gateway’s OpenAPI extensions to model these properties.

Default:

  • merge for REST APIs created after March 29, 2021, otherwise overwrite

parameters

Custom header parameters for the request.

Default:

  • No parameters.

See:

https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

policy

A policy document that contains the permissions for this RestApi.

Default:

  • No policy.

rest_api_name

A name for the API Gateway RestApi resource.

Default:

  • ID of the RestApi construct.

retain_deployments

Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.

Default:

false