Bases: RestApiBase
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.
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))
scope (Construct)
id (str)
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.
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.
Methods
Add an ApiKey.
id (str)
api_key_name (Optional[str]) â A name for the API key. If you donât specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. Default: automically generated name
description (Optional[str]) â A description of the purpose of the API key. Default: none
value (Optional[str]) â The value of the API key. Must be at least 20 characters long. Default: none
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.
Defines an API Gateway domain name and maps it to this API.
id (str) â The construct id.
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.
base_path (Optional[str]) â The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it canât be an empty string. Default: - map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.
endpoint_type (Optional[EndpointType]) â The type of endpoint for this DomainName. Default: REGIONAL
mtls (Union[MTLSConfig, Dict[str, Any], None]) â The mutual TLS authentication configuration for a custom domain name. Default: - mTLS is not configured.
security_policy (Optional[SecurityPolicy]) â The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_0
Adds a new gateway response.
id (str)
type (ResponseType) â Response type to associate with gateway response.
response_headers (Optional[Mapping[str, str]]) â Custom headers parameters for response. Default: - no headers
status_code (Optional[str]) â Http status code for response. Default: - standard http status code for the response type.
templates (Optional[Mapping[str, str]]) â Custom templates to get mapped as response. Default: - Response from api will be returned without applying any transformation.
Adds a new model.
id (str)
schema (Union[JsonSchema, Dict[str, Any]]) â 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: âapplication/jsonâ
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.
Adds a new request validator.
id (str)
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
Adds a usage plan.
id (str)
api_key (Optional[IApiKey]) â (deprecated) ApiKey to be associated with the usage plan. Default: none
api_stages (Optional[Sequence[Union[UsagePlanPerApiStage, Dict[str, Any]]]]) â API Stages to be associated with 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 (Union[QuotaSettings, Dict[str, Any], None]) â Number of requests clients can make in a given time period. Default: none
throttle (Union[ThrottleSettings, Dict[str, Any], None]) â Overall throttle settings for the API. Default: none
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because youâve removed it from the CDK application or because youâve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
policy (RemovalPolicy)
None
Gets the âexecute-apiâ ARN.
method (Optional[str])
path (Optional[str])
stage (Optional[str])
str
Returns the given named metric for this API.
metric_name (str)
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the number of requests served from the API cache in a given period.
Default: sum over 5 minutes
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Default: sum over 5 minutes
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the number of client-side errors captured in a given period.
Default: sum over 5 minutes
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the total number API requests in a given period.
Default: sample count over 5 minutes
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Default: average over 5 minutes.
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
The time between when API Gateway receives a request from a client and when it returns a response to the client.
The latency includes the integration latency and other API Gateway overhead.
Default: average over 5 minutes.
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Metric for the number of server-side errors captured in a given period.
Default: sum over 5 minutes
account (Optional[str]) â Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) â The hex color code, prefixed with â#â (e.g. â#00ff00â), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) â (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) â Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) â
Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graphâs legend. Default: - No label
period (Optional[Duration]) â The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) â Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) â What function to use for aggregating. Can be one of the following: - âMinimumâ | âminâ - âMaximumâ | âmaxâ - âAverageâ | âavgâ - âSumâ | âsumâ - âSampleCount | ânâ - âpNN.NNâ Default: Average
unit (Optional[Unit]) â Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
Returns a string representation of this construct.
str
Returns the URL for an HTTP path.
Fails if deploymentStage is not set either by deploy or explicitly.
path (Optional[str])
str
Attributes
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.
The first domain name mapped to this API, if defined through the domainName configuration prop, or added via addDomainName.
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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.
The list of methods bound to this RestApi.
The construct tree node associated with this construct.
The ID of this API Gateway RestApi.
A human friendly name for this Rest API.
Note that this is different from restApiId.
true
The resource ID of the root resource.
Represents the root resource of this API endpoint (â/â).
Resources and Methods are added to this resource.
The stack in which this resource is defined.
The deployed root URL of this REST API.
Static Methods
Import an existing RestApi that can be configured with additional Methods and Resources.
Import an existing RestApi.
Return whether the given object is a Construct.
x (Any)
bool
Check whether the given construct is a Resource.
construct (IConstruct)
bool
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4