class StageBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.StageBase |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#StageBase |
![]() | software.amazon.awscdk.services.apigateway.StageBase |
![]() | aws_cdk.aws_apigateway.StageBase |
![]() | aws-cdk-lib » aws_apigateway » StageBase |
Implements
IConstruct
, IDependable
, IResource
, IStage
Extends
Resource
Implemented by
Stage
Base class for an ApiGateway Stage.
Initializer
new StageBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
rest | IRest | RestApi to which this stage is associated. |
stack | Stack | The stack in which this resource is defined. |
stage | string | Returns the resource ARN for this stage:. |
stage | string | Name of this stage. |
env
Type:
Resource
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.
node
Type:
Node
The tree node.
restApi
Type:
IRest
RestApi to which this stage is associated.
stack
Type:
Stack
The stack in which this resource is defined.
stageArn
Type:
string
Returns the resource ARN for this stage:.
arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}
Note that this is separate from the execute-api ARN for methods and resources within this stage.
stageName
Type:
string
Name of this stage.
Methods
Name | Description |
---|---|
add | Add an ApiKey to this stage. |
apply | Apply the given removal policy to this resource. |
metric(metricName, props?) | Returns the given named metric for this stage. |
metric | Metric for the number of requests served from the API cache in a given period. |
metric | Metric for the number of requests served from the backend in a given period, when API caching is enabled. |
metric | Metric for the number of client-side errors captured in a given period. |
metric | Metric for the total number API requests in a given period. |
metric | Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. |
metric | The time between when API Gateway receives a request from a client and when it returns a response to the client. |
metric | Metric for the number of server-side errors captured in a given period. |
to | Returns a string representation of this construct. |
url | Returns the invoke URL for a certain path. |
addApiKey(id, options?)
public addApiKey(id: string, options?: ApiKeyOptions): IApiKey
Parameters
- id
string
- options
Api
Key Options
Returns
Add an ApiKey to this stage.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Returns the given named metric for this stage.
metricCacheHitCount(props?)
public metricCacheHitCount(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of requests served from the API cache in a given period.
metricCacheMissCount(props?)
public metricCacheMissCount(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of requests served from the backend in a given period, when API caching is enabled.
metricClientError(props?)
public metricClientError(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of client-side errors captured in a given period.
metricCount(props?)
public metricCount(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the total number API requests in a given period.
metricIntegrationLatency(props?)
public metricIntegrationLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
metricLatency(props?)
public metricLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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.
metricServerError(props?)
public metricServerError(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of server-side errors captured in a given period.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
urlForPath(path?)
public urlForPath(path?: string): string
Parameters
- path
string
— The resource path.
Returns
string
Returns the invoke URL for a certain path.