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 usingaddCorsPreflight
. Default: - CORS is disableddefault_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 namedescription (
Optional
[str
]) – A description of the purpose of the API key. Default: nonevalue (
Optional
[str
]) – The value of the API key. Must be at least 20 characters long. Default: nonecustomer_id (
Optional
[str
]) – An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. Default: noneenabled (
Optional
[bool
]) – Indicates whether the API key can be used by clients. Default: truegenerate_distinct_id (
Optional
[bool
]) – Specifies whether the key identifier is distinct from the created API key value. Default: falseresources (
Optional
[Sequence
[IRestApi
]]) – (deprecated) A list of resources this api key is associated with. Default: nonestages (
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=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_apigateway as apigateway # authorizer: apigateway.Authorizer # integration: apigateway.Integration # model: apigateway.Model # request_validator: apigateway.RequestValidator # rest_api: apigateway.RestApi # stage: apigateway.Stage api_key_props = apigateway.ApiKeyProps( api_key_name="apiKeyName", customer_id="customerId", default_cors_preflight_options=apigateway.CorsOptions( allow_origins=["allowOrigins"], # the properties below are optional allow_credentials=False, allow_headers=["allowHeaders"], allow_methods=["allowMethods"], disable_cache=False, expose_headers=["exposeHeaders"], max_age=cdk.Duration.minutes(30), status_code=123 ), default_integration=integration, default_method_options=apigateway.MethodOptions( api_key_required=False, authorization_scopes=["authorizationScopes"], authorization_type=apigateway.AuthorizationType.NONE, authorizer=authorizer, method_responses=[apigateway.MethodResponse( status_code="statusCode", # the properties below are optional response_models={ "response_models_key": model }, response_parameters={ "response_parameters_key": False } )], operation_name="operationName", request_models={ "request_models_key": model }, request_parameters={ "request_parameters_key": False }, request_validator=request_validator, request_validator_options=apigateway.RequestValidatorOptions( request_validator_name="requestValidatorName", validate_request_body=False, validate_request_parameters=False ) ), description="description", enabled=False, generate_distinct_id=False, resources=[rest_api], stages=[stage], value="value" )
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:
- customer_id
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
- 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.
- enabled
Indicates whether the API key can be used by clients.
- generate_distinct_id
Specifies whether the key identifier is distinct from the created API key value.
- 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.