ApiKey

class aws_cdk.aws_apigateway.ApiKey(scope, id, *, customer_id=None, enabled=None, generate_distinct_id=None, resources=None, api_key_name=None, description=None, value=None, default_cors_preflight_options=None, default_integration=None, default_method_options=None)

Bases: Resource

An API Gateway ApiKey.

An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.

ExampleMetadata:

infused

Example:

imported_key = apigateway.ApiKey.from_api_key_id(self, "imported-key", "<api-key-id>")
Parameters:

  • scope (Construct) –

  • id (str) –

  • customer_id (Optional[str]) – An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. Default: none

  • enabled (Optional[bool]) – Indicates whether the API key can be used by clients. Default: true

  • generate_distinct_id (Optional[bool]) – Specifies whether the key identifier is distinct from the created API key value. Default: false

  • resources (Optional[Sequence[IRestApi]]) – A list of resources this api key is associated with. Default: none

  • api_key_name (Optional[str]) – 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. Default: automically generated name

  • description (Optional[str]) – A description of the purpose of the API key. Default: none

  • value (Optional[str]) – The value of the API key. Must be at least 20 characters long. Default: none

  • default_cors_preflight_options (Union[CorsOptions, Dict[str, Any], None]) – Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using addCorsPreflight. Default: - CORS is disabled

  • default_integration (Optional[Integration]) – An integration to use as a default for all methods created within this API unless an integration is specified. Default: - Inherited from parent.

  • default_method_options (Union[MethodOptions, Dict[str, Any], None]) – Method options to use as a default for all methods created within this API unless custom options are specified. Default: - Inherited from parent.

Methods

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant_read(grantee)

Permits the IAM principal all read operations through this key.

Parameters:

grantee (IGrantable) – The principal to grant access to.

Return type:

Grant

grant_read_write(grantee)

Permits the IAM principal all read and write operations through this key.

Parameters:

grantee (IGrantable) – The principal to grant access to.

Return type:

Grant

grant_write(grantee)

Permits the IAM principal all write operations through this key.

Parameters:

grantee (IGrantable) – The principal to grant access to.

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

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.

key_arn

The API key ARN.

key_id

The API key ID.

node

The construct tree node associated with this construct.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_api_key_id(scope, id, api_key_id)

Import an ApiKey by its Id.

Parameters:

  • scope (Construct) –

  • id (str) –

  • api_key_id (str) –

Return type:

IApiKey

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool