ApiKeyProps Struct
ApiKey Properties.
Example
ts
const stack = new Stack(app, 'my-stack', {
propertyInjectors: [new ApiKeyPropsInjector()],
});
new api.ApiKey(stack, 'my-api-key', {});
Properties
apiKeyNameoptionalstringapi_key_nameoptionalstrapiKeyNameoptionalStringApiKeyNameoptionalstringApiKeyNameoptional*string#A name for the API key.
Default: automically generated name
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
customerIdoptionalstringcustomer_idoptionalstrcustomerIdoptionalStringCustomerIdoptionalstringCustomerIdoptional*string= none#An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
defaultCorsPreflightOptionsoptionalCorsOptionsdefault_cors_preflight_optionsoptionalCorsOptionsdefaultCorsPreflightOptionsoptionalCorsOptionsDefaultCorsPreflightOptionsoptionalCorsOptionsDefaultCorsPreflightOptionsoptionalCorsOptions#Adds a CORS preflight OPTIONS method to this resource and all child resources.
Default: CORS is disabled
You can add CORS at the resource-level using addCorsPreflight.
defaultIntegrationoptionalIntegrationdefault_integrationoptionalIntegrationdefaultIntegrationoptionalIntegrationDefaultIntegrationoptionalIntegrationDefaultIntegrationoptionalIntegration#An integration to use as a default for all methods created within this API unless an integration is specified.
Default: Inherited from parent.
defaultMethodOptionsoptionalMethodOptionsdefault_method_optionsoptionalMethodOptionsdefaultMethodOptionsoptionalMethodOptionsDefaultMethodOptionsoptionalMethodOptionsDefaultMethodOptionsoptionalMethodOptions#Method options to use as a default for all methods created within this API unless custom options are specified.
Default: Inherited from parent.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#A description of the purpose of the API key.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#Indicates whether the API key can be used by clients.
generateDistinctIdoptionalbooleangenerate_distinct_idoptionalboolgenerateDistinctIdoptionalBooleanGenerateDistinctIdoptionalboolGenerateDistinctIdoptional*bool= false#Specifies whether the key identifier is distinct from the created API key value.
resourcesoptionalIRestApi[]resourcesoptionaltyping.List[IRestApi]resourcesoptionalList<IRestApi>ResourcesoptionalIRestApi[]Resourcesoptional*[]IRestApi= nonedeprecated#- use `stages` instead
stagesoptionalIStage[]stagesoptionaltyping.List[IStage]stagesoptionalList<IStage>StagesoptionalIStage[]Stagesoptional*[]IStage#A list of Stages this api key is associated with.
Default: the api key is not associated with any stages
valueoptionalstringvalueoptionalstrvalueoptionalStringValueoptionalstringValueoptional*string= none#The value of the API key.
Must be at least 20 characters long.