aws-cdk-lib.aws_apigateway.CfnStage

class CfnStage (construct)

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnStage
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnStage
Javasoftware.amazon.awscdk.services.apigateway.CfnStage
Pythonaws_cdk.aws_apigateway.CfnStage
TypeScript aws-cdk-lib » aws_apigateway » CfnStage

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::ApiGateway::Stage.

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

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 cfnStage = new apigateway.CfnStage(this, 'MyCfnStage', {
  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',
  },
});

Initializer

new CfnStage(scope: Construct, id: string, props: CfnStageProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnStageProps — - resource properties.

Create a new AWS::ApiGateway::Stage.

Construct Props

NameTypeDescription
restApiIdstringThe string identifier of the associated RestApi.
accessLogSetting?IResolvable | AccessLogSettingPropertyAccess log settings, including the access log format and access log destination ARN.
cacheClusterEnabled?boolean | IResolvableSpecifies whether a cache cluster is enabled for the stage.
cacheClusterSize?stringThe stage's cache capacity in GB.
canarySetting?IResolvable | CanarySettingPropertySettings for the canary deployment in this stage.
clientCertificateId?stringThe identifier of a client certificate for an API stage.
deploymentId?stringThe identifier of the Deployment that the stage points to.
description?stringThe stage's description.
documentationVersion?stringThe version of the associated API documentation.
methodSettings?IResolvable | IResolvable | MethodSettingProperty[]A map that defines the method settings for a Stage resource.
stageName?stringThe 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 | IResolvableSpecifies whether active tracing with X-ray is enabled for the Stage.
variables?IResolvable | { [string]: string }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.


accessLogSetting?

Type: IResolvable | AccessLogSettingProperty (optional)

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


cacheClusterEnabled?

Type: boolean | IResolvable (optional)

Specifies whether a cache cluster is enabled for the stage.


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 .


canarySetting?

Type: IResolvable | CanarySettingProperty (optional)

Settings for the canary deployment in this stage.


clientCertificateId?

Type: string (optional)

The identifier of a client certificate for an API stage.


deploymentId?

Type: string (optional)

The identifier of the Deployment that the stage points to.


description?

Type: string (optional)

The stage's description.


documentationVersion?

Type: string (optional)

The version of the associated API documentation.


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.


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.


tags?

Type: CfnTag[] (optional)

The collection of tags.

Each tag element is associated with a given resource.


tracingEnabled?

Type: boolean | IResolvable (optional)

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


variables?

Type: IResolvable | { [string]: string } (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-._~:/?#&=,]+ .

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
restApiIdstringThe string identifier of the associated RestApi.
stackStackThe stack in which this element is defined.
tagsTagManagerThe collection of tags.
accessLogSetting?IResolvable | AccessLogSettingPropertyAccess log settings, including the access log format and access log destination ARN.
cacheClusterEnabled?boolean | IResolvableSpecifies whether a cache cluster is enabled for the stage.
cacheClusterSize?stringThe stage's cache capacity in GB.
canarySetting?IResolvable | CanarySettingPropertySettings for the canary deployment in this stage.
clientCertificateId?stringThe identifier of a client certificate for an API stage.
deploymentId?stringThe identifier of the Deployment that the stage points to.
description?stringThe stage's description.
documentationVersion?stringThe version of the associated API documentation.
methodSettings?IResolvable | IResolvable | MethodSettingProperty[]A map that defines the method settings for a Stage resource.
stageName?stringThe name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
tracingEnabled?boolean | IResolvableSpecifies whether active tracing with X-ray is enabled for the Stage.
variables?IResolvable | { [string]: string }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.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


restApiId

Type: string

The string identifier of the associated RestApi.


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

The collection of tags.

Each tag element is associated with a given resource.


accessLogSetting?

Type: IResolvable | AccessLogSettingProperty (optional)

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


cacheClusterEnabled?

Type: boolean | IResolvable (optional)

Specifies whether a cache cluster is enabled for the stage.


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 .


canarySetting?

Type: IResolvable | CanarySettingProperty (optional)

Settings for the canary deployment in this stage.


clientCertificateId?

Type: string (optional)

The identifier of a client certificate for an API stage.


deploymentId?

Type: string (optional)

The identifier of the Deployment that the stage points to.


description?

Type: string (optional)

The stage's description.


documentationVersion?

Type: string (optional)

The version of the associated API documentation.


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.


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.


tracingEnabled?

Type: boolean | IResolvable (optional)

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


variables?

Type: IResolvable | { [string]: string } (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-._~:/?#&=,]+ .


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }