Interface IHttpApi
- All Superinterfaces:
IApi
,software.constructs.IConstruct
,software.constructs.IDependable
,IResource
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IHttpApi.Jsii$Default
- All Known Implementing Classes:
HttpApi
,IHttpApi.Jsii$Proxy
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIHttpApi
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionaddVpcLink
(VpcLinkProps options) Add a new VpcLink.Get the "execute-api" ARN.arnForExecuteApi
(String method) Get the "execute-api" ARN.arnForExecuteApi
(String method, String path) Get the "execute-api" ARN.arnForExecuteApi
(String method, String path, String stage) Get the "execute-api" ARN.Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.default IHttpRouteAuthorizer
Default Authorizer applied to all routes in the gateway.Metric for the number of client-side errors captured in a given period.metricClientError
(MetricOptions props) Metric for the number of client-side errors captured in a given period.Metric for the total number API requests in a given period.metricCount
(MetricOptions props) Metric for the total number API requests in a given period.Metric for the amount of data processed in bytes.metricDataProcessed
(MetricOptions props) Metric for the amount of data processed in bytes.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.The time between when API Gateway receives a request from a client and when it returns a response to the client.metricLatency
(MetricOptions props) The time between when API Gateway receives a request from a client and when it returns a response to the client.Metric for the number of server-side errors captured in a given period.metricServerError
(MetricOptions props) Metric for the number of server-side errors captured in a given period.Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.IApi
getApiEndpoint, getApiId, metric, metric
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDefaultAuthorizationScopes
Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.
Default: - no default authorization scopes
-
getDefaultAuthorizer
Default Authorizer applied to all routes in the gateway.Default: - no default authorizer
-
addVpcLink
Add a new VpcLink.- Parameters:
options
- This parameter is required.
-
arnForExecuteApi
@Stability(Stable) @NotNull String arnForExecuteApi(@Nullable String method, @Nullable String path, @Nullable String stage) Get the "execute-api" ARN.When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.
Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.
- Parameters:
method
-path
-stage
-
-
arnForExecuteApi
Get the "execute-api" ARN.When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.
Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.
- Parameters:
method
-path
-
-
arnForExecuteApi
Get the "execute-api" ARN.When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.
Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.
- Parameters:
method
-
-
arnForExecuteApi
Get the "execute-api" ARN.When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.
Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.
-
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
-
metricCount
Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
- Parameters:
props
-
-
metricCount
Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
-
metricDataProcessed
Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricDataProcessed
Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
-
metricIntegrationLatency
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Default: - no statistic
- Parameters:
props
-
-
metricIntegrationLatency
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Default: - no statistic
-
metricLatency
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: - no statistic
- Parameters:
props
-
-
metricLatency
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: - no statistic
-
metricServerError
Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricServerError
Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
-