2.233.0

interface StageKeyProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnApiKeyPropsMixin.StageKeyProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnApiKeyPropsMixin_StageKeyProperty
Javasoftware.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnApiKeyPropsMixin.StageKeyProperty
Pythonaws_cdk.mixins_preview.aws_apigateway.mixins.CfnApiKeyPropsMixin.StageKeyProperty
TypeScript @aws-cdk/mixins-preview » aws_apigateway » mixins » CfnApiKeyPropsMixin » 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 { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const stageKeyProperty: apigateway_mixins.CfnApiKeyPropsMixin.StageKeyProperty = {
  restApiId: 'restApiId',
  stageName: 'stageName',
};

Properties

NameTypeDescription
restApiId?stringThe string identifier of the associated RestApi.
stageName?stringThe 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

← PreviousNext →