ApiKey

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

Bases: aws_cdk.core.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.

__init__(scope, id, *, customer_id=None, description=None, enabled=None, generate_distinct_id=None, resources=None, api_key_name=None, value=None, default_cors_preflight_options=None, default_integration=None, default_method_options=None)
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

  • description (Optional[str]) – A description of the purpose of the API key. 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[List[RestApi]]) – [disable-awslint:ref-via-interface] 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

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

  • default_cors_preflight_options (Optional[CorsOptions]) – 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 (Optional[MethodOptions]) – Method options to use as a default for all methods created within this API unless custom options are specified. Default: - Inherited from parent.

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

key_id

The API key ID.

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

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