interface CfnAPIKeyMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Location.Mixins.CfnAPIKeyMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslocation/mixins#CfnAPIKeyMixinProps
Java	software.amazon.awscdk.mixins.preview.services.location.mixins.CfnAPIKeyMixinProps
Python	aws_cdk.mixins_preview.aws_location.mixins.CfnAPIKeyMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_location » mixins » CfnAPIKeyMixinProps

Properties for CfnAPIKeyPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as location_mixins } from '@aws-cdk/mixins-preview/aws-location';
const cfnAPIKeyMixinProps: location_mixins.CfnAPIKeyMixinProps = {
  description: 'description',
  expireTime: 'expireTime',
  forceDelete: false,
  forceUpdate: false,
  keyName: 'keyName',
  noExpiry: false,
  restrictions: {
    allowActions: ['allowActions'],
    allowAndroidApps: [{
      certificateFingerprint: 'certificateFingerprint',
      package: 'package',
    }],
    allowAppleApps: [{
      bundleId: 'bundleId',
    }],
    allowReferers: ['allowReferers'],
    allowResources: ['allowResources'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
description?	string	Updates the description for the API key resource.
expireTime?	string	The optional timestamp for when the API key resource will expire in ISO 8601 format .
forceDelete?	boolean | IResolvable	ForceDelete bypasses an API key's expiry conditions and deletes the key.
forceUpdate?	boolean | IResolvable	The boolean flag to be included for updating ExpireTime or Restrictions details.
keyName?	string	A custom name for the API key resource.
noExpiry?	boolean | IResolvable	Whether the API key should expire.
restrictions?	IResolvable | ApiKeyRestrictionsProperty	The API key restrictions for the API key resource.
tags?	CfnTag[]	Applies one or more tags to the map resource.

---

description?

Type: string (optional)

Updates the description for the API key resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-description

---

expireTime?

Type: string (optional)

The optional timestamp for when the API key resource will expire in ISO 8601 format .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-expiretime

---

forceDelete?

Type: boolean | IResolvable (optional)

ForceDelete bypasses an API key's expiry conditions and deletes the key.

Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true , or false .

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forcedelete

---

forceUpdate?

Type: boolean | IResolvable (optional)

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forceupdate

---

keyName?

Type: string (optional)

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique API key name.
• No spaces allowed. For example, ExampleAPIKey .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-keyname

---

noExpiry?

Type: boolean | IResolvable (optional)

Whether the API key should expire.

Set to true to set the API key to have no expiration time.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-noexpiry

---

restrictions?

Type: IResolvable | ApiKeyRestrictionsProperty (optional)

The API key restrictions for the API key resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-restrictions

---

tags?

Type: CfnTag[] (optional)

Applies one or more tags to the map resource.

A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-tags