RestApiProps

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

Bases: RestApiOptions

Props to create a new instance of RestApi.

Parameters:

  • 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 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.

  • 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_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

  • default_cors_preflight_options (Union[CorsOptions, Dict[str, Any], None]) – 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 (Union[MethodOptions, Dict[str, Any], None]) – 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[Sequence[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.

  • description (Optional[str]) – A description of the purpose of this API Gateway RestApi resource. Default: - No description.

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

  • 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.

ExampleMetadata:

infused

Example:

state_machine = stepfunctions.StateMachine(self, "MyStateMachine",
    state_machine_type=stepfunctions.StateMachineType.EXPRESS,
    definition=stepfunctions.Chain.start(stepfunctions.Pass(self, "Pass"))
)

api = apigateway.RestApi(self, "Api",
    rest_api_name="MyApi"
)
api.root.add_method("GET", apigateway.StepFunctionsIntegration.start_execution(state_machine))

Attributes

api_key_source_type

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

Default:

  • Metering is disabled.

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:

  • RestApi supports only UTF-8-encoded text payloads.

clone_from

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

Default:

  • None.

cloud_watch_role

Automatically configure an AWS CloudWatch role for API Gateway.

Default:

true

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:

  • CORS is disabled

default_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

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

Default:

  • Inherited from parent.

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 purpose of this API Gateway RestApi resource.

Default:

  • No description.

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

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:

  • Compression is disabled.

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