StepFunctionsRestApi
- class aws_cdk.aws_apigateway.StepFunctionsRestApi(scope, id, *, state_machine, authorizer=None, headers=None, path=None, querystring=None, request_context=None, role=None, use_default_method_responses=None, api_key_source_type=None, binary_media_types=None, clone_from=None, endpoint_configuration=None, min_compression_size=None, minimum_compression_size=None, default_cors_preflight_options=None, default_integration=None, default_method_options=None, 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_export_name=None, endpoint_types=None, fail_on_warnings=None, parameters=None, policy=None, rest_api_name=None, retain_deployments=None)
Bases:
RestApi
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
- ExampleMetadata:
infused
Example:
# machine: stepfunctions.IStateMachine apigateway.StepFunctionsRestApi(self, "StepFunctionsRestApi", state_machine=machine, use_default_method_responses=False )
- Parameters:
scope (
Construct
) –id (
str
) –state_machine (
IStateMachine
) – The default State Machine that handles all requests from this API. This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise inaddMethod
.authorizer (
Optional
[bool
]) – If the whole authorizer object, including custom context values should be in the execution input. The execution input will include a new keyauthorizer
: { “body”: {}, “authorizer”: { “key”: “value” } } Default: falseheaders (
Optional
[bool
]) – Check if header is to be included inside the execution input. The execution input will include a new keyheaders
: { “body”: {}, “headers”: { “header1”: “value”, “header2”: “value” } } Default: falsepath (
Optional
[bool
]) – Check if path is to be included inside the execution input. The execution input will include a new keypath
: { “body”: {}, “path”: { “resourceName”: “resourceValue” } } Default: truequerystring (
Optional
[bool
]) – Check if querystring is to be included inside the execution input. The execution input will include a new keyqueryString
: { “body”: {}, “querystring”: { “key”: “value” } } Default: truerequest_context (
Union
[RequestContext
,Dict
[str
,Any
],None
]) – Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc. The execution input will include a new keyrequestContext
: { “body”: {}, “requestContext”: { “key”: “value” } } Default: - all parameters within request context will be set as falserole (
Optional
[IRole
]) – An IAM role that API Gateway will assume to start the execution of the state machine. Default: - a new role is createduse_default_method_responses (
Optional
[bool
]) – Whether to add default response models with 200, 400, and 500 status codes to the method. Default: trueapi_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.endpoint_configuration (
Union
[EndpointConfiguration
,Dict
[str
,Any
],None
]) – The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGEmin_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.minimum_compression_size (
Union
[int
,float
,None
]) – (deprecated) 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.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 usingaddCorsPreflight
. Default: - CORS is disableddefault_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.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 otherwisecloud_watch_role_removal_policy (
Optional
[RemovalPolicy
]) – The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. RequirescloudWatchRole
to be enabled. Default: - RemovalPolicy.RETAINdeploy (
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 theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: truedeploy_options (
Union
[StageOptions
,Dict
[str
,Any
],None
]) – Options for the API Gateway stage that will always point to the latest deployment whendeploy
is enabled. Ifdeploy
is disabled, this value cannot be set. Default: - Based on defaults ofStageOptions
.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: falsedomain_name (
Union
[DomainNameOptions
,Dict
[str
,Any
],None
]) – Configure a custom domain name and map it to this API. Default: - no domain name is defined, useaddDomainName
or directly define aDomainName
.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 exportendpoint_types (
Optional
[Sequence
[EndpointType
]]) – A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGEfail_on_warnings (
Optional
[bool
]) – Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: falseparameters (
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
Methods
- add_api_key(id, *, api_key_name=None, description=None, value=None, default_cors_preflight_options=None, default_integration=None, default_method_options=None)
Add an ApiKey to the deploymentStage.
- Parameters:
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 namedescription (
Optional
[str
]) – A description of the purpose of the API key. Default: nonevalue (
Optional
[str
]) – The value of the API key. Must be at least 20 characters long. Default: nonedefault_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 usingaddCorsPreflight
. Default: - CORS is disableddefault_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.
- Return type:
- add_domain_name(id, *, certificate, domain_name, base_path=None, endpoint_type=None, mtls=None, security_policy=None)
Defines an API Gateway domain name and maps it to this API.
- Parameters:
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
).endpoint_type (
Optional
[EndpointType
]) – The type of endpoint for this DomainName. Default: REGIONALmtls (
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_2
- Return type:
- add_gateway_response(id, *, type, response_headers=None, status_code=None, templates=None)
Adds a new gateway response.
- Parameters:
id (
str
) –type (
ResponseType
) – Response type to associate with gateway response.response_headers (
Optional
[Mapping
[str
,str
]]) – Custom headers parameters for response. Default: - no headersstatus_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.
- Return type:
- add_model(id, *, schema, content_type=None, description=None, model_name=None)
Adds a new model.
- Parameters:
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: Nonemodel_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:
- add_request_validator(id, *, request_validator_name=None, validate_request_body=None, validate_request_parameters=None)
Adds a new request validator.
- Parameters:
id (
str
) –request_validator_name (
Optional
[str
]) – The name of this request validator. Default: Nonevalidate_request_body (
Optional
[bool
]) – Indicates whether to validate the request body according to the configured schema for the targeted API and method. Default: falsevalidate_request_parameters (
Optional
[bool
]) – Indicates whether to validate request parameters. Default: false
- Return type:
- add_usage_plan(id, *, api_stages=None, description=None, name=None, quota=None, throttle=None)
Adds a usage plan.
- Parameters:
id (
str
) –api_stages (
Optional
[Sequence
[Union
[UsagePlanPerApiStage
,Dict
[str
,Any
]]]]) – API Stages to be associated with the usage plan. Default: nonedescription (
Optional
[str
]) – Represents usage plan purpose. Default: nonename (
Optional
[str
]) – Name for this usage plan. Default: nonequota (
Union
[QuotaSettings
,Dict
[str
,Any
],None
]) – Number of requests clients can make in a given time period. Default: nonethrottle (
Union
[ThrottleSettings
,Dict
[str
,Any
],None
]) – Overall throttle settings for the API. Default: none
- Return type:
- apply_removal_policy(policy)
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
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- arn_for_execute_api(method=None, path=None, stage=None)
Gets the “execute-api” ARN.
- Parameters:
method (
Optional
[str
]) –path (
Optional
[str
]) –stage (
Optional
[str
]) –
- Return type:
str
- metric(metric_name, *, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Returns the given named metric for this API.
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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 labelperiod (
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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_cache_hit_count(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Metric for the number of requests served from the API cache in a given period.
Default: sum over 5 minutes
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_cache_miss_count(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Default: sum over 5 minutes
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_client_error(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Metric for the number of client-side errors captured in a given period.
Default: sum over 5 minutes
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_count(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Metric for the total number API requests in a given period.
Default: sample count over 5 minutes
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_integration_latency(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
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.
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_latency(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
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.
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- metric_server_error(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)
Metric for the number of server-side errors captured in a given period.
Default: sum over 5 minutes
- Parameters:
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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_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. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
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
- Return type:
- 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 bydeploy
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.
- domain_name
The first domain name mapped to this API, if defined through the
domainName
configuration prop, or added viaaddDomainName
.
- env
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.
- 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.
- methods
The list of methods bound to this RestApi.
- node
The tree node.
- rest_api_id
The ID of this API Gateway RestApi.
- rest_api_name
A human friendly name for this Rest API.
Note that this is different from
restApiId
.- Attribute:
true
- rest_api_root_resource_id
The resource ID of the root resource.
- root
Represents the root resource of this API endpoint (‘/’).
Resources and Methods are added to this resource.
- stack
The stack in which this resource is defined.
- url
The deployed root URL of this REST API.
Static Methods
- classmethod from_rest_api_attributes(scope, id, *, rest_api_id, root_resource_id, rest_api_name=None)
Import an existing RestApi that can be configured with additional Methods and Resources.
- classmethod from_rest_api_id(scope, id, rest_api_id)
Import an existing RestApi.
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_rest_api(x)
Return whether the given object is a
RestApi
.- Parameters:
x (
Any
) –- Return type:
bool