CfnStage¶
-
class
aws_cdk.aws_apigateway.
CfnStage
(scope, id, *, rest_api_id, access_log_setting=None, cache_cluster_enabled=None, cache_cluster_size=None, canary_setting=None, client_certificate_id=None, deployment_id=None, description=None, documentation_version=None, method_settings=None, stage_name=None, tags=None, tracing_enabled=None, variables=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::ApiGateway::Stage
.The
AWS::ApiGateway::Stage
resource creates a stage for a deployment.- CloudformationResource
AWS::ApiGateway::Stage
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.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_stage = apigateway.CfnStage(self, "MyCfnStage", rest_api_id="restApiId", # the properties below are optional access_log_setting=apigateway.CfnStage.AccessLogSettingProperty( destination_arn="destinationArn", format="format" ), cache_cluster_enabled=False, cache_cluster_size="cacheClusterSize", canary_setting=apigateway.CfnStage.CanarySettingProperty( deployment_id="deploymentId", percent_traffic=123, stage_variable_overrides={ "stage_variable_overrides_key": "stageVariableOverrides" }, use_stage_cache=False ), client_certificate_id="clientCertificateId", deployment_id="deploymentId", description="description", documentation_version="documentationVersion", method_settings=[apigateway.CfnStage.MethodSettingProperty( cache_data_encrypted=False, cache_ttl_in_seconds=123, caching_enabled=False, data_trace_enabled=False, http_method="httpMethod", logging_level="loggingLevel", metrics_enabled=False, resource_path="resourcePath", throttling_burst_limit=123, throttling_rate_limit=123 )], stage_name="stageName", tags=[CfnTag( key="key", value="value" )], tracing_enabled=False, variables={ "variables_key": "variables" } )
Create a new
AWS::ApiGateway::Stage
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
rest_api_id (
str
) – The ID of theRestApi
resource that you’re deploying with this stage.access_log_setting (
Union
[IResolvable
,AccessLogSettingProperty
,None
]) – Specifies settings for logging access in this stage.cache_cluster_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether cache clustering is enabled for the stage.cache_cluster_size (
Optional
[str
]) – The stage’s cache cluster size.canary_setting (
Union
[IResolvable
,CanarySettingProperty
,None
]) – Specifies settings for the canary deployment in this stage.client_certificate_id (
Optional
[str
]) – The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.deployment_id (
Optional
[str
]) – The ID of the deployment that the stage is associated with. This parameter is required to create a stage.description (
Optional
[str
]) – A description of the stage.documentation_version (
Optional
[str
]) – The version ID of the API documentation snapshot.method_settings (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MethodSettingProperty
]],None
]) – Settings for all methods in the stage.stage_name (
Optional
[str
]) – The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).tags (
Optional
[Sequence
[CfnTag
]]) – An array of arbitrary tags (key-value pairs) to associate with the stage.tracing_enabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether active X-Ray tracing is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .variables (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression:[A-Za-z0-9-._~:/?#&=,]+
.
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::Stage'¶
-
access_log_setting
¶ Specifies settings for logging access in this stage.
-
cache_cluster_enabled
¶ Indicates whether cache clustering is enabled for the stage.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
cache_cluster_size
¶ The stage’s cache cluster size.
-
canary_setting
¶ Specifies settings for the canary deployment in this stage.
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
client_certificate_id
¶ The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
-
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
]
-
deployment_id
¶ The ID of the deployment that the stage is associated with.
This parameter is required to create a stage.
-
description
¶ A description of the stage.
-
documentation_version
¶ The version ID of the API documentation snapshot.
-
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.
-
method_settings
¶ Settings for all methods in the stage.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,MethodSettingProperty
]],None
]
-
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
-
rest_api_id
¶ The ID of the
RestApi
resource that you’re deploying with this stage.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
stage_name
¶ The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
An array of arbitrary tags (key-value pairs) to associate with the stage.
-
tracing_enabled
¶ Specifies whether active X-Ray tracing is enabled for this stage.
For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
variables
¶ A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.
Variable names are limited to alphanumeric characters. Values must match the following regular expression:
[A-Za-z0-9-._~:/?#&=,]+
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]
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
AccessLogSettingProperty¶
-
class
CfnStage.
AccessLogSettingProperty
(*, destination_arn=None, format=None)¶ Bases:
object
The
AccessLogSetting
property type specifies settings for logging access in this stage.AccessLogSetting
is a property of the AWS::ApiGateway::Stage resource.- Parameters
destination_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin withamazon-apigateway-
. This parameter is required to enable access logging.format (
Optional
[str
]) – A single line format of the access logs of data, as specified by selected $context variables . The format must include at least$context.requestId
. This parameter is required to enable access logging.
- 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 access_log_setting_property = apigateway.CfnStage.AccessLogSettingProperty( destination_arn="destinationArn", format="format" )
Attributes
-
destination_arn
¶ The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with
amazon-apigateway-
. This parameter is required to enable access logging.
-
format
¶ //docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference>`_ . The format must include at least
$context.requestId
. This parameter is required to enable access logging.- Link
- Type
A single line format of the access logs of data, as specified by selected `$context variables <https
- Return type
Optional
[str
]
CanarySettingProperty¶
-
class
CfnStage.
CanarySettingProperty
(*, deployment_id=None, percent_traffic=None, stage_variable_overrides=None, use_stage_cache=None)¶ Bases:
object
The
CanarySetting
property type specifies settings for the canary deployment in this stage.CanarySetting
is a property of the AWS::ApiGateway::Stage resource.- Parameters
deployment_id (
Optional
[str
]) – The identifier of the deployment that the stage points to.percent_traffic (
Union
[int
,float
,None
]) – The percentage (0-100) of traffic diverted to a canary deployment.stage_variable_overrides (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. Duplicates are not allowed.use_stage_cache (
Union
[bool
,IResolvable
,None
]) – Whether the canary deployment uses the stage cache or not.
- 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 canary_setting_property = apigateway.CfnStage.CanarySettingProperty( deployment_id="deploymentId", percent_traffic=123, stage_variable_overrides={ "stage_variable_overrides_key": "stageVariableOverrides" }, use_stage_cache=False )
Attributes
-
deployment_id
¶ The identifier of the deployment that the stage points to.
-
percent_traffic
¶ The percentage (0-100) of traffic diverted to a canary deployment.
- Link
- Return type
Union
[int
,float
,None
]
-
stage_variable_overrides
¶ Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
These stage variables are represented as a string-to-string map between stage variable names and their values.
Duplicates are not allowed.
- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]
-
use_stage_cache
¶ Whether the canary deployment uses the stage cache or not.
MethodSettingProperty¶
-
class
CfnStage.
MethodSettingProperty
(*, cache_data_encrypted=None, cache_ttl_in_seconds=None, caching_enabled=None, data_trace_enabled=None, http_method=None, logging_level=None, metrics_enabled=None, resource_path=None, throttling_burst_limit=None, throttling_rate_limit=None)¶ Bases:
object
The
MethodSetting
property type configures settings for all methods in a stage.The
MethodSettings
property of theAWS::ApiGateway::Stage
resource contains a list ofMethodSetting
property types.- Parameters
cache_data_encrypted (
Union
[bool
,IResolvable
,None
]) – Indicates whether the cached responses are encrypted.cache_ttl_in_seconds (
Union
[int
,float
,None
]) – The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.caching_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.data_trace_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.http_method (
Optional
[str
]) – The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.logging_level (
Optional
[str
]) – The logging level for this method. For valid values, see theloggingLevel
property of the Stage resource in the Amazon API Gateway API Reference .metrics_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.resource_path (
Optional
[str
]) – The resource path for this method. Forward slashes (/
) are encoded as~1
and the initial slash must include a forward slash. For example, the path value/resource/subresource
must be encoded as/~1resource~1subresource
. To specify the root path, use only a slash (/
). To apply settings to multiple resources and methods, specify an asterisk (*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.throttling_burst_limit (
Union
[int
,float
,None
]) – The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account . For more information, see Manage API Request Throttling in the API Gateway Developer Guide .throttling_rate_limit (
Union
[int
,float
,None
]) –The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account . For more information, see Manage API Request Throttling in the API Gateway Developer Guide .
- 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 method_setting_property = apigateway.CfnStage.MethodSettingProperty( cache_data_encrypted=False, cache_ttl_in_seconds=123, caching_enabled=False, data_trace_enabled=False, http_method="httpMethod", logging_level="loggingLevel", metrics_enabled=False, resource_path="resourcePath", throttling_burst_limit=123, throttling_rate_limit=123 )
Attributes
-
cache_data_encrypted
¶ Indicates whether the cached responses are encrypted.
-
cache_ttl_in_seconds
¶ The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
-
caching_enabled
¶ Indicates whether responses are cached and returned for requests.
You must enable a cache cluster on the stage to cache responses.
-
data_trace_enabled
¶ Indicates whether data trace logging is enabled for methods in the stage.
API Gateway pushes these logs to Amazon CloudWatch Logs.
-
http_method
¶ The HTTP method.
To apply settings to multiple resources and methods, specify an asterisk (
*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.
-
logging_level
¶ The logging level for this method.
For valid values, see the
loggingLevel
property of the Stage resource in the Amazon API Gateway API Reference .
-
metrics_enabled
¶ Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
-
resource_path
¶ The resource path for this method.
Forward slashes (
/
) are encoded as~1
and the initial slash must include a forward slash. For example, the path value/resource/subresource
must be encoded as/~1resource~1subresource
. To specify the root path, use only a slash (/
). To apply settings to multiple resources and methods, specify an asterisk (*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.
-
throttling_burst_limit
¶ The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .
For more information, see Manage API Request Throttling in the API Gateway Developer Guide .
-
throttling_rate_limit
¶ The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .
For more information, see Manage API Request Throttling in the API Gateway Developer Guide .