interface StageKeyProperty

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

StageKey is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.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 stageKeyProperty: apigateway.CfnApiKey.StageKeyProperty = {
  restApiId: 'restApiId',
  stageName: 'stageName',
};

Properties

Name	Type	Description
restApiId?	string	The string identifier of the associated RestApi.
stageName?	string	The stage name associated with the stage key.

---

restApiId?

Type: string (optional)

The string identifier of the associated RestApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid

---

stageName?

Type: string (optional)

The stage name associated with the stage key.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename