AwsWafv2ApiKeyArgs

interface AwsWafv2ApiKeyArgs extends Omit<aws.wafv2.ApiKeyArgs, 'scope'> {
identity: string;
region?: Input<string | undefined>;
scope: 'CLOUDFRONT' | 'REGIONAL';
tokenDomains: Input<Input<string>[]>;
}

Input arguments for the WAFv2 API key capability.

Remarks

scope and tokenDomains map directly to aws wafv2 create-api-key. identity is logical-only and is not sent to AWS. For CLOUDFRONT scope, AWS requires the resource region to be us-east-1.

Example

CODE

const apiKeyArgs: AwsWafv2ApiKeyArgs = {
  identity: 'captchaApiKey',
  scope: 'REGIONAL',
  tokenDomains: ['example.com'],
};

Hierarchy

ApiKeyArgs, "scope">
AwsWafv2ApiKeyArgs

Properties

`identity: string`

Logical-only identity for the API key. It is never forwarded to AWS.

`region: Input<string | undefined>`

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

`scope: 'CLOUDFRONT' | 'REGIONAL'`

Scope for the API key.

`tokenDomains: Input<Input<string>[]>`

Inherited from tokenDomains

The domains that you want to be able to use the API key with, for example example.com. You can specify up to 5 domains. Changing this forces a new resource to be created.