CfnApiKey¶
-
class
aws_cdk.aws_apigateway.
CfnApiKey
(scope, id, *, customer_id=None, description=None, enabled=None, generate_distinct_id=None, name=None, stage_keys=None, tags=None, value=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::ApiGateway::ApiKey
.The
AWS::ApiGateway::ApiKey
resource creates a unique key that you can distribute to clients who are executing API GatewayMethod
resources that require an API key. To specify which API key clients must use, map the API key with theRestApi
andStage
resources that include the methods that require a key.- CloudformationResource
AWS::ApiGateway::ApiKey
- 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 = apigateway.CfnApiKey(self, "MyCfnApiKey", 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" )
Create a new
AWS::ApiGateway::ApiKey
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
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.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::ApiGateway::ApiKey'¶
-
attr_api_key_id
¶ The ID for the API key.
For example:
abc123
.- CloudformationAttribute
APIKeyId
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
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.
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
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
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
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.
-
value
¶ The value of the API key.
Must be at least 20 characters long.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
StageKeyProperty¶
-
class
CfnApiKey.
StageKeyProperty
(*, rest_api_id=None, stage_name=None)¶ Bases:
object
StageKey
is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.- Parameters
rest_api_id (
Optional
[str
]) – The ID of aRestApi
resource that includes the stage with which you want to associate the API key.stage_name (
Optional
[str
]) – The name of the stage with which to associate the API key. The stage must be included in theRestApi
resource that you specified in theRestApiId
property.
- Link
- 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 stage_key_property = apigateway.CfnApiKey.StageKeyProperty( rest_api_id="restApiId", stage_name="stageName" )
Attributes
-
rest_api_id
¶ The ID of a
RestApi
resource that includes the stage with which you want to associate the API key.
-
stage_name
¶ The name of the stage with which to associate the API key.
The stage must be included in the
RestApi
resource that you specified in theRestApiId
property.