class ApiKey (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.ApiKey |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#ApiKey |
![]() | software.amazon.awscdk.services.apigateway.ApiKey |
![]() | aws_cdk.aws_apigateway.ApiKey |
![]() | aws-cdk-lib » aws_apigateway » ApiKey |
Implements
IConstruct
, IDependable
, IResource
, IApi
An API Gateway ApiKey.
An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.
Example
const importedKey = apigateway.ApiKey.fromApiKeyId(this, 'imported-key', '<api-key-id>');
Initializer
new ApiKey(scope: Construct, id: string, props?: ApiKeyProps)
Parameters
- scope
Construct
- id
string
- props
Api
Key Props
Construct Props
Name | Type | Description |
---|---|---|
api | string | A name for the API key. |
customer | string | An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. |
default | Cors | Adds a CORS preflight OPTIONS method to this resource and all child resources. |
default | Integration | An integration to use as a default for all methods created within this API unless an integration is specified. |
default | Method | Method options to use as a default for all methods created within this API unless custom options are specified. |
description? | string | A description of the purpose of the API key. |
enabled? | boolean | Indicates whether the API key can be used by clients. |
generate | boolean | Specifies whether the key identifier is distinct from the created API key value. |
resources? | IRest [] | A list of resources this api key is associated with. |
stages? | IStage [] | A list of Stages this api key is associated with. |
value? | string | The value of the API key. |
apiKeyName?
Type:
string
(optional, default: automically generated name)
A name for the API key.
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
customerId?
Type:
string
(optional, default: none)
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
defaultCorsPreflightOptions?
Type:
Cors
(optional, default: CORS is disabled)
Adds a CORS preflight OPTIONS method to this resource and all child resources.
You can add CORS at the resource-level using addCorsPreflight
.
defaultIntegration?
Type:
Integration
(optional, default: Inherited from parent.)
An integration to use as a default for all methods created within this API unless an integration is specified.
defaultMethodOptions?
Type:
Method
(optional, default: Inherited from parent.)
Method options to use as a default for all methods created within this API unless custom options are specified.
description?
Type:
string
(optional, default: none)
A description of the purpose of the API key.
enabled?
Type:
boolean
(optional, default: true)
Indicates whether the API key can be used by clients.
generateDistinctId?
Type:
boolean
(optional, default: false)
Specifies whether the key identifier is distinct from the created API key value.
resources?
⚠️ Deprecated: - use stages
instead
Type:
IRest
[]
(optional, default: none)
A list of resources this api key is associated with.
stages?
Type:
IStage
[]
(optional, default: the api key is not associated with any stages)
A list of Stages this api key is associated with.
value?
Type:
string
(optional, default: none)
The value of the API key.
Must be at least 20 characters long.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
key | string | The API key ARN. |
key | string | The API key ID. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
keyArn
Type:
string
The API key ARN.
keyId
Type:
string
The API key ID.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Permits the IAM principal all read operations through this key. |
grant | Permits the IAM principal all read and write operations through this key. |
grant | Permits the IAM principal all write operations through this key. |
to | Returns a string representation of this construct. |
static from | Import an ApiKey by its Id. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits the IAM principal all read operations through this key.
grantReadWrite(grantee)
public grantReadWrite(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits the IAM principal all read and write operations through this key.
grantWrite(grantee)
public grantWrite(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— The principal to grant access to.
Returns
Permits the IAM principal all write operations through this key.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromApiKeyId(scope, id, apiKeyId)
public static fromApiKeyId(scope: Construct, id: string, apiKeyId: string): IApiKey
Parameters
- scope
Construct
- id
string
- apiKeyId
string
Returns
Import an ApiKey by its Id.