interface CfnStageProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnStageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnStageProps
Java	software.amazon.awscdk.services.apigateway.CfnStageProps
Python	aws_cdk.aws_apigateway.CfnStageProps
TypeScript	aws-cdk-lib » aws_apigateway » CfnStageProps

Properties for defining a CfnStage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnStageProps: apigateway.CfnStageProps = {
  restApiId: 'restApiId',

  // the properties below are optional
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  cacheClusterEnabled: false,
  cacheClusterSize: 'cacheClusterSize',
  canarySetting: {
    deploymentId: 'deploymentId',
    percentTraffic: 123,
    stageVariableOverrides: {
      stageVariableOverridesKey: 'stageVariableOverrides',
    },
    useStageCache: false,
  },
  clientCertificateId: 'clientCertificateId',
  deploymentId: 'deploymentId',
  description: 'description',
  documentationVersion: 'documentationVersion',
  methodSettings: [{
    cacheDataEncrypted: false,
    cacheTtlInSeconds: 123,
    cachingEnabled: false,
    dataTraceEnabled: false,
    httpMethod: 'httpMethod',
    loggingLevel: 'loggingLevel',
    metricsEnabled: false,
    resourcePath: 'resourcePath',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  }],
  stageName: 'stageName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tracingEnabled: false,
  variables: {
    variablesKey: 'variables',
  },
};

Properties

Name	Type	Description
restApiId	string	The string identifier of the associated RestApi.
accessLogSetting?	IResolvable | AccessLogSettingProperty	Access log settings, including the access log format and access log destination ARN.
cacheClusterEnabled?	boolean | IResolvable	Specifies whether a cache cluster is enabled for the stage.
cacheClusterSize?	string	The stage's cache capacity in GB.
canarySetting?	IResolvable | CanarySettingProperty	Settings for the canary deployment in this stage.
clientCertificateId?	string	The identifier of a client certificate for an API stage.
deploymentId?	string	The identifier of the Deployment that the stage points to.
description?	string	The stage's description.
documentationVersion?	string	The version of the associated API documentation.
methodSettings?	IResolvable | IResolvable | MethodSettingProperty[]	A map that defines the method settings for a Stage resource.
stageName?	string	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
tags?	CfnTag[]	The collection of tags.
tracingEnabled?	boolean | IResolvable	Specifies whether active tracing with X-ray is enabled for the Stage.
variables?	{ [string]: string } | IResolvable	A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

---

restApiId

Type: string

The string identifier of the associated RestApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid

---

accessLogSetting?

Type: IResolvable | AccessLogSettingProperty (optional)

Access log settings, including the access log format and access log destination ARN.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting

---

cacheClusterEnabled?

Type: boolean | IResolvable (optional)

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled

---

cacheClusterSize?

Type: string (optional)

The stage's cache capacity in GB.

For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize

---

canarySetting?

Type: IResolvable | CanarySettingProperty (optional)

Settings for the canary deployment in this stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting

---

clientCertificateId?

Type: string (optional)

The identifier of a client certificate for an API stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid

---

deploymentId?

Type: string (optional)

The identifier of the Deployment that the stage points to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid

---

description?

Type: string (optional)

The stage's description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description

---

documentationVersion?

Type: string (optional)

The version of the associated API documentation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion

---

methodSettings?

Type: IResolvable | IResolvable | MethodSettingProperty[] (optional)

A map that defines the method settings for a Stage resource.

Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings

---

stageName?

Type: string (optional)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename

---

tags?

Type: CfnTag[] (optional)

The collection of tags.

Each tag element is associated with a given resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags

---

tracingEnabled?

Type: boolean | IResolvable (optional)

Specifies whether active tracing with X-ray is enabled for the Stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled

---

variables?

Type: { [string]: string } | IResolvable (optional)

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables