ApiKeyProps

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

Bases: ApiKeyOptions

ApiKey Properties.

Parameters:

  • 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.

  • 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

  • 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]]) – (deprecated) A list of resources this api key is associated with. Default: none

  • stages (Optional[Sequence[IStage]]) – A list of Stages this api key is associated with. Default: - the api key is not associated with any stages

ExampleMetadata:

fixture=README-blueprints infused

Example:

stack = Stack(app, "my-stack",
    property_injectors=[ApiKeyPropsInjector()]
)
api.ApiKey(stack, "my-api-key")

Attributes

api_key_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.

Default:

automically generated name

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

customer_id

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

Default:

none

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

default_cors_preflight_options

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

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

Method options to use as a default for all methods created within this API unless custom options are specified.

Default:

  • Inherited from parent.

description

A description of the purpose of the API key.

Default:

none

Link:

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

enabled

Indicates whether the API key can be used by clients.

Default:

true

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

generate_distinct_id

Specifies whether the key identifier is distinct from the created API key value.

Default:

false

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

resources

(deprecated) A list of resources this api key is associated with.

Default:

none

Deprecated:

  • use stages instead

Stability:

deprecated

stages

A list of Stages this api key is associated with.

Default:

  • the api key is not associated with any stages

value

The value of the API key.

Must be at least 20 characters long.

Default:

none

Link:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value