LambdaRestApiProps

class aws_cdk.aws_apigateway.LambdaRestApiProps(*, default_cors_preflight_options=None, default_integration=None, default_method_options=None, api_key_source_type=None, binary_media_types=None, clone_from=None, cloud_watch_role=None, deploy=None, deploy_options=None, description=None, domain_name=None, endpoint_export_name=None, endpoint_types=None, fail_on_warnings=None, minimum_compression_size=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None, handler, options=None, proxy=None)

Bases: aws_cdk.aws_apigateway.RestApiProps

__init__(*, default_cors_preflight_options=None, default_integration=None, default_method_options=None, api_key_source_type=None, binary_media_types=None, clone_from=None, cloud_watch_role=None, deploy=None, deploy_options=None, description=None, domain_name=None, endpoint_export_name=None, endpoint_types=None, fail_on_warnings=None, minimum_compression_size=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None, handler, options=None, proxy=None)
Parameters
  • default_cors_preflight_options (Optional[CorsOptions]) – Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using addCorsPreflight. Default: - CORS is disabled

  • default_integration (Optional[Integration]) – An integration to use as a default for all methods created within this API unless an integration is specified. Default: - Inherited from parent.

  • default_method_options (Optional[MethodOptions]) – Method options to use as a default for all methods created within this API unless custom options are specified. Default: - Inherited from parent.

  • api_key_source_type (Optional[ApiKeySourceType]) – The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.

  • binary_media_types (Optional[List[str]]) – The list of binary media mime-types that are supported by the RestApi resource, such as “image/png” or “application/octet-stream”. Default: - RestApi supports only UTF-8-encoded text payloads.

  • clone_from (Optional[IRestApi]) – The ID of the API Gateway RestApi resource that you want to clone. Default: - None.

  • cloud_watch_role (Optional[bool]) – Automatically configure an AWS CloudWatch role for API Gateway. Default: true

  • 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 deployStageOptions property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: true

  • deploy_options (Optional[StageOptions]) – 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 purpose of this API Gateway RestApi resource. Default: - No description.

  • domain_name (Optional[DomainNameOptions]) – 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_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[List[EndpointType]]) – A list of the endpoint types of the API. Use this property when creating an API. Default: - No endpoint types.

  • 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

  • minimum_compression_size (Union[int, float, None]) – A nullable integer 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.

  • 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

  • handler (IFunction) – The default Lambda function that handles all requests from this API. This handler will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

  • options (Optional[RestApiProps]) – Default: - no options.

  • proxy (Optional[bool]) – If true, route all requests to the Lambda Function. If set to false, you will need to explicitly define the API model using addResource and addMethod (or addProxy). Default: true

Attributes

api_key_source_type

The source of the API key for metering requests according to a usage plan.

default :default: - Metering is disabled.

Return type

Optional[ApiKeySourceType]

binary_media_types

The list of binary media mime-types that are supported by the RestApi resource, such as “image/png” or “application/octet-stream”.

default :default: - RestApi supports only UTF-8-encoded text payloads.

Return type

Optional[List[str]]

clone_from

The ID of the API Gateway RestApi resource that you want to clone.

default :default: - None.

Return type

Optional[IRestApi]

cloud_watch_role

Automatically configure an AWS CloudWatch role for API Gateway.

default :default: true

Return type

Optional[bool]

default_cors_preflight_options

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

default :default: - CORS is disabled

Return type

Optional[CorsOptions]

default_integration

An integration to use as a default for all methods created within this API unless an integration is specified.

default :default: - Inherited from parent.

Return type

Optional[Integration]

default_method_options

Method options to use as a default for all methods created within this API unless custom options are specified.

default :default: - Inherited from parent.

Return type

Optional[MethodOptions]

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 deployStageOptions property.

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

default :default: true

Return type

Optional[bool]

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 :default: - Based on defaults of StageOptions.

Return type

Optional[StageOptions]

description

A description of the purpose of this API Gateway RestApi resource.

default :default: - No description.

Return type

Optional[str]

domain_name

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

default :default: - no domain name is defined, use addDomainName or directly define a DomainName.

Return type

Optional[DomainNameOptions]

endpoint_export_name

Export name for the CfnOutput containing the API endpoint.

default :default: - when no export name is given, output will be created without export

Return type

Optional[str]

endpoint_types

A list of the endpoint types of the API.

Use this property when creating an API.

default :default: - No endpoint types.

Return type

Optional[List[EndpointType]]

fail_on_warnings

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

default :default: false

Return type

Optional[bool]

handler

The default Lambda function that handles all requests from this API.

This handler will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

Return type

IFunction

minimum_compression_size

A nullable integer 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 :default: - Compression is disabled.

Return type

Union[int, float, None]

options

default :default: - no options.

deprecated :deprecated:

the LambdaRestApiProps now extends RestApiProps, so all options are just available here. Note that the options specified in options will be overridden by any props specified at the root level.

stability :stability: deprecated

Return type

Optional[RestApiProps]

parameters

Custom header parameters for the request.

default :default: - No parameters.

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

Return type

Optional[Mapping[str, str]]

policy

A policy document that contains the permissions for this RestApi.

default :default: - No policy.

Return type

Optional[PolicyDocument]

proxy

If true, route all requests to the Lambda Function.

If set to false, you will need to explicitly define the API model using addResource and addMethod (or addProxy).

default :default: true

Return type

Optional[bool]

rest_api_name

A name for the API Gateway RestApi resource.

default :default: - ID of the RestApi construct.

Return type

Optional[str]

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 :default: false

Return type

Optional[bool]