RestApi

class aws_cdk.aws_apigateway.RestApi(scope, id, *, 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, default_cors_preflight_options=None, default_integration=None, default_method_options=None)

Bases: aws_cdk.core.Resource

Represents a REST API in Amazon API Gateway.

Use addResource and addMethod to configure the API model.

By default, the API will automatically be deployed and accessible from a public endpoint.

__init__(scope, id, *, 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, default_cors_preflight_options=None, default_integration=None, default_method_options=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • 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

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

Return type

None

Methods

add_api_key(id)

Add an ApiKey.

Parameters

id (str) –

Return type

IApiKey

add_domain_name(id, *, certificate, domain_name, endpoint_type=None)

Defines an API Gateway domain name and maps it to this API.

Parameters
  • id (str) – The construct id.

  • options – custom domain options.

  • certificate (ICertificate) – The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

  • domain_name (str) – The custom domain name for your API. Uppercase letters are not supported.

  • endpoint_type (Optional[EndpointType]) – The type of endpoint for this DomainName. Default: REGIONAL

Return type

DomainName

add_model(id, *, schema, content_type=None, description=None, model_name=None)

Adds a new model.

Parameters
  • id (str) –

  • props

  • schema (JsonSchema) – The schema to use to transform data to one or more output formats. Specify null ({}) if you don’t want to specify a schema.

  • content_type (Optional[str]) – The content type for the model. You can also force a content type in the request or response model mapping. Default: -

  • description (Optional[str]) – A description that identifies this model. Default: None

  • model_name (Optional[str]) – A name for the model. Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. Default: If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type.

Return type

Model

add_request_validator(id, *, request_validator_name=None, validate_request_body=None, validate_request_parameters=None)

Adds a new request validator.

Parameters
  • id (str) –

  • props

  • request_validator_name (Optional[str]) – The name of this request validator. Default: None

  • validate_request_body (Optional[bool]) – Indicates whether to validate the request body according to the configured schema for the targeted API and method. Default: false

  • validate_request_parameters (Optional[bool]) – Indicates whether to validate request parameters. Default: false

Return type

RequestValidator

add_usage_plan(id, *, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)

Adds a usage plan.

Parameters
  • id (str) –

  • props

  • api_key (Optional[IApiKey]) – ApiKey to be associated with the usage plan. Default: none

  • api_stages (Optional[List[UsagePlanPerApiStage]]) – API Stages to be associated which the usage plan. Default: none

  • description (Optional[str]) – Represents usage plan purpose. Default: none

  • name (Optional[str]) – Name for this usage plan. Default: none

  • quota (Optional[QuotaSettings]) – Number of requests clients can make in a given time period. Default: none

  • throttle (Optional[ThrottleSettings]) – Overall throttle settings for the API. Default: none

Return type

UsagePlan

arn_for_execute_api(method=None, path=None, stage=None)
Parameters
  • method (Optional[str]) – The method (default *).

  • path (Optional[str]) – The resource path. Must start with ‘/’ (default *)

  • stage (Optional[str]) – The stage (default *).

default :default:

“*” returns the execute API ARN for all methods/resources in this API.

return :rtype: str :return: The “execute-api” ARN.

to_string()

Returns a string representation of this construct.

Return type

str

url_for_path(path=None)

Returns the URL for an HTTP path.

Fails if deploymentStage is not set either by deploy or explicitly.

Parameters

path (Optional[str]) –

Return type

str

Attributes

deployment_stage

API Gateway stage that points to the latest deployment (if defined).

If deploy is disabled, you will need to explicitly assign this value in order to set up integrations.

Return type

Stage

domain_name

The domain name mapped to this API, if defined through the domainName configuration prop.

Return type

Optional[DomainName]

latest_deployment

API Gateway deployment that represents the latest changes of the API. This resource will be automatically updated every time the REST API model changes. This will be undefined if deploy is false.

Return type

Optional[Deployment]

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

rest_api_id

The ID of this API Gateway RestApi.

Return type

str

rest_api_root_resource_id

The resource ID of the root resource.

attribute: :attribute:: true

Return type

str

root

.

api.root.addMethod(‘ANY’, redirectToHomePage); // “ANY /” api.root.addResource(‘friends’).addMethod(‘GET’, getFriendsHandler); // “GET /friends”

Type

Represents the root resource (“/”) of this API. Use it to define the API model

Return type

IResource

stack

The stack in which this resource is defined.

Return type

Stack

url

The deployed root URL of this REST API.

Return type

str

Static Methods

classmethod from_rest_api_id(scope, id, rest_api_id)
Parameters
  • scope (Construct) –

  • id (str) –

  • rest_api_id (str) –

Return type

IRestApi

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool