class CfnApiKeyPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnApiKeyPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnApiKeyPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnApiKeyPropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnApiKeyPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnApiKeyPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key.

To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnApiKeyPropsMixin = new apigateway_mixins.CfnApiKeyPropsMixin({
  customerId: 'customerId',
  description: 'description',
  enabled: false,
  generateDistinctId: false,
  name: 'name',
  stageKeys: [{
    restApiId: 'restApiId',
    stageName: 'stageName',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  value: 'value',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnApiKeyPropsMixin(props: CfnApiKeyMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnApiKeyMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGateway::ApiKey.

Properties

Name	Type	Description
props	CfnApiKeyMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnApiKeyMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.