CfnApiKeyProps¶
-
class
aws_cdk.aws_apigateway.
CfnApiKeyProps
(*, customer_id=None, description=None, enabled=None, generate_distinct_id=None, name=None, stage_keys=None, tags=None, value=None)¶ Bases:
object
Properties for defining a
CfnApiKey
.- Parameters
customer_id (
Optional
[str
]) – An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.description (
Optional
[str
]) – A description of the purpose of the API key.enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether the API key can be used by clients.generate_distinct_id (
Union
[bool
,IResolvable
,None
]) – Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.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. For more information, see Name Type . .. epigraph:: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.stage_keys (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,StageKeyProperty
]],None
]) – A list of stages to associate with this API key.tags (
Optional
[Sequence
[CfnTag
]]) – An array of arbitrary tags (key-value pairs) to associate with the API key.value (
Optional
[str
]) – The value of the API key. Must be at least 20 characters long.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html
- 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.aws_apigateway as apigateway cfn_api_key_props = apigateway.CfnApiKeyProps( customer_id="customerId", description="description", enabled=False, generate_distinct_id=False, name="name", stage_keys=[apigateway.CfnApiKey.StageKeyProperty( rest_api_id="restApiId", stage_name="stageName" )], tags=[CfnTag( key="key", value="value" )], value="value" )
Attributes
-
customer_id
¶ An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
-
description
¶ A description of the purpose of the API key.
-
enabled
¶ Indicates whether the API key can be used by clients.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
generate_distinct_id
¶ Specifies whether the key identifier is distinct from the created API key value.
This parameter is deprecated and should not be used.
-
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. For more information, see Name Type . .. epigraph:
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Link
- Return type
Optional
[str
]
-
stage_keys
¶ A list of stages to associate with this API key.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,StageKeyProperty
]],None
]
An array of arbitrary tags (key-value pairs) to associate with the API key.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
value
¶ The value of the API key.
Must be at least 20 characters long.