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:
CfnResourceA CloudFormation
AWS::ApiGateway::Stage.The
AWS::ApiGateway::Stageresource 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 string identifier of the associated RestApi.access_log_setting (
Union[IResolvable,AccessLogSettingProperty,Dict[str,Any],None]) – Access log settings, including the access log format and access log destination ARN.cache_cluster_enabled (
Union[bool,IResolvable,None]) – Specifies whether a cache cluster is enabled for the stage.cache_cluster_size (
Optional[str]) – The stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .canary_setting (
Union[IResolvable,CanarySettingProperty,Dict[str,Any],None]) – Settings for the canary deployment in this stage.client_certificate_id (
Optional[str]) – The identifier of a client certificate for an API stage.deployment_id (
Optional[str]) – The identifier of the Deployment that the stage points to.description (
Optional[str]) – The stage’s description.documentation_version (
Optional[str]) – The version of the associated API documentation.method_settings (
Union[IResolvable,Sequence[Union[IResolvable,MethodSettingProperty,Dict[str,Any]]],None]) – A map that defines the method settings for a Stage resource. Keys (designated as/{method_setting_keybelow) are method paths defined as{resource_path}/{http_method}for an individual method override, or/\* /\*for overriding all methods in the stage.stage_name (
Optional[str]) – The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The collection of tags. Each tag element is associated with a given resource.tracing_enabled (
Union[bool,IResolvable,None]) – Specifies whether active tracing with X-ray is enabled for the Stage.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:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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:
- Return type:
Any
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.
- 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
Access log settings, including the access log format and access log destination ARN.
- cache_cluster_enabled
Specifies whether a cache cluster is enabled for the stage.
- cache_cluster_size
The stage’s cache capacity in GB.
For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
- canary_setting
Settings for the canary deployment in this stage.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- client_certificate_id
The identifier of a client certificate for an API 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.
- deployment_id
The identifier of the Deployment that the stage points to.
- description
The stage’s description.
- documentation_version
The version of the associated API documentation.
- 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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- method_settings
A map that defines the method settings for a Stage resource.
Keys (designated as
/{method_setting_keybelow) are method paths defined as{resource_path}/{http_method}for an individual method override, or/\* /\*for overriding all methods in the stage.
- node
The construct tree node associated with this construct.
- 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 }).
- rest_api_id
The string identifier of the associated RestApi.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- stage_name
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- tags
The collection of tags.
Each tag element is associated with a given resource.
- tracing_enabled
Specifies whether active tracing with X-ray is enabled for the Stage.
- 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-._~:/?#&=,]+.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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:
objectThe
AccessLogSettingproperty type specifies settings for logging access in this stage.AccessLogSettingis 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
CanarySettingProperty
- class CfnStage.CanarySettingProperty(*, deployment_id=None, percent_traffic=None, stage_variable_overrides=None, use_stage_cache=None)
Bases:
objectConfiguration settings of a canary deployment.
- Parameters:
deployment_id (
Optional[str]) – The ID of the canary deployment.percent_traffic (
Union[int,float,None]) – The percent (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.use_stage_cache (
Union[bool,IResolvable,None]) – A Boolean flag to indicate 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 ID of the canary deployment.
- percent_traffic
The percent (0-100) of traffic diverted to a canary deployment.
- 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.
- use_stage_cache
A Boolean flag to indicate 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:
objectThe
MethodSettingproperty type configures settings for all methods in a stage.The
MethodSettingsproperty of theAWS::ApiGateway::Stageresource contains a list ofMethodSettingproperty types.- Parameters:
cache_data_encrypted (
Union[bool,IResolvable,None]) – Specifies whether the cached responses are encrypted.cache_ttl_in_seconds (
Union[int,float,None]) – Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.caching_enabled (
Union[bool,IResolvable,None]) – Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.data_trace_enabled (
Union[bool,IResolvable,None]) – Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.http_method (
Optional[str]) – The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for theHttpMethodand/*for theResourcePath. This parameter is required when you specify aMethodSetting.logging_level (
Optional[str]) – Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values areOFF,ERROR, andINFO. ChooseERRORto write only error-level entries to CloudWatch Logs, or chooseINFOto include allERRORevents as well as extra informational events.metrics_enabled (
Union[bool,IResolvable,None]) – Specifies whether Amazon CloudWatch metrics are enabled for this method.resource_path (
Optional[str]) – The resource path for this method. Forward slashes (/) are encoded as~1and the initial slash must include a forward slash. For example, the path value/resource/subresourcemust 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 theHttpMethodand/*for theResourcePath. This parameter is required when you specify aMethodSetting.throttling_burst_limit (
Union[int,float,None]) – Specifies the throttling burst limit.throttling_rate_limit (
Union[int,float,None]) – Specifies the throttling rate limit.
- 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
Specifies whether the cached responses are encrypted.
- cache_ttl_in_seconds
Specifies the time to live (TTL), in seconds, for cached responses.
The higher the TTL, the longer the response will be cached.
- caching_enabled
Specifies whether responses should be cached and returned for requests.
A cache cluster must be enabled on the stage for responses to be cached.
- data_trace_enabled
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
- http_method
The HTTP method.
To apply settings to multiple resources and methods, specify an asterisk (
*) for theHttpMethodand/*for theResourcePath. This parameter is required when you specify aMethodSetting.
- logging_level
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
Valid values are
OFF,ERROR, andINFO. ChooseERRORto write only error-level entries to CloudWatch Logs, or chooseINFOto include allERRORevents as well as extra informational events.
- metrics_enabled
Specifies whether Amazon CloudWatch metrics are enabled for this method.
- resource_path
The resource path for this method.
Forward slashes (
/) are encoded as~1and the initial slash must include a forward slash. For example, the path value/resource/subresourcemust 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 theHttpMethodand/*for theResourcePath. This parameter is required when you specify aMethodSetting.
- throttling_burst_limit
Specifies the throttling burst limit.
- throttling_rate_limit
Specifies the throttling rate limit.