CfnApiGatewayManagedOverrides¶
-
class
aws_cdk.aws_apigatewayv2.
CfnApiGatewayManagedOverrides
(scope, id, *, api_id, integration=None, route=None, stage=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::ApiGatewayV2::ApiGatewayManagedOverrides
.The
AWS::ApiGatewayV2::ApiGatewayManagedOverrides
resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create. When you create an API by using quick create, anAWS::ApiGatewayV2::Route
,AWS::ApiGatewayV2::Integration
, andAWS::ApiGatewayV2::Stage
are created for you and associated with yourAWS::ApiGatewayV2::Api
. TheAWS::ApiGatewayV2::ApiGatewayManagedOverrides
resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.- CloudformationResource
AWS::ApiGatewayV2::ApiGatewayManagedOverrides
- 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_apigatewayv2 as apigatewayv2 # route_settings: Any # stage_variables: Any cfn_api_gateway_managed_overrides = apigatewayv2.CfnApiGatewayManagedOverrides(self, "MyCfnApiGatewayManagedOverrides", api_id="apiId", # the properties below are optional integration=apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty( description="description", integration_method="integrationMethod", payload_format_version="payloadFormatVersion", timeout_in_millis=123 ), route=apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty( authorization_scopes=["authorizationScopes"], authorization_type="authorizationType", authorizer_id="authorizerId", operation_name="operationName", target="target" ), stage=apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty( access_log_settings=apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty( destination_arn="destinationArn", format="format" ), auto_deploy=False, default_route_settings=apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 ), description="description", route_settings=route_settings, stage_variables=stage_variables ) )
Create a new
AWS::ApiGatewayV2::ApiGatewayManagedOverrides
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
api_id (
str
) – The ID of the API for which to override the configuration of API Gateway-managed resources.integration (
Union
[IResolvable
,IntegrationOverridesProperty
,None
]) – Overrides the integration configuration for an API Gateway-managed integration.route (
Union
[IResolvable
,RouteOverridesProperty
,None
]) – Overrides the route configuration for an API Gateway-managed route.stage (
Union
[IResolvable
,StageOverridesProperty
,None
]) – Overrides the stage configuration for an API Gateway-managed stage.
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::ApiGatewayV2::ApiGatewayManagedOverrides'¶
-
api_id
¶ The ID of the API for which to override the configuration of API Gateway-managed resources.
-
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
]
-
integration
¶ Overrides the integration configuration for an API Gateway-managed integration.
-
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.
-
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
-
route
¶ Overrides the route configuration for an API Gateway-managed route.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
stage
¶ Overrides the stage configuration for an API Gateway-managed stage.
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
AccessLogSettingsProperty¶
-
class
CfnApiGatewayManagedOverrides.
AccessLogSettingsProperty
(*, destination_arn=None, format=None)¶ Bases:
object
The
AccessLogSettings
property overrides the access log settings for an API Gateway-managed stage.- Parameters
destination_arn (
Optional
[str
]) – The ARN of the CloudWatch Logs log group to receive access logs.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.
- 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_apigatewayv2 as apigatewayv2 access_log_settings_property = apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty( destination_arn="destinationArn", format="format" )
Attributes
-
destination_arn
¶ The ARN of the CloudWatch Logs log group to receive access logs.
-
format
¶ A single line format of the access logs of data, as specified by selected $context variables.
The format must include at least $context.requestId.
IntegrationOverridesProperty¶
-
class
CfnApiGatewayManagedOverrides.
IntegrationOverridesProperty
(*, description=None, integration_method=None, payload_format_version=None, timeout_in_millis=None)¶ Bases:
object
The
IntegrationOverrides
property overrides the integration settings for an API Gateway-managed integration.If you remove this property, API Gateway restores the default values.
- Parameters
description (
Optional
[str
]) – The description of the integration.integration_method (
Optional
[str
]) – Specifies the integration’s HTTP method type.payload_format_version (
Optional
[str
]) – Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are1.0
and2.0
. For all other integrations,1.0
is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .timeout_in_millis (
Union
[int
,float
,None
]) – Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
- 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_apigatewayv2 as apigatewayv2 integration_overrides_property = apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty( description="description", integration_method="integrationMethod", payload_format_version="payloadFormatVersion", timeout_in_millis=123 )
Attributes
-
description
¶ The description of the integration.
-
integration_method
¶ Specifies the integration’s HTTP method type.
-
payload_format_version
¶ Specifies the format of the payload sent to an integration.
Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are
1.0
and2.0
. For all other integrations,1.0
is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .
-
timeout_in_millis
¶ Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
RouteOverridesProperty¶
-
class
CfnApiGatewayManagedOverrides.
RouteOverridesProperty
(*, authorization_scopes=None, authorization_type=None, authorizer_id=None, operation_name=None, target=None)¶ Bases:
object
The
RouteOverrides
property overrides the route configuration for an API Gateway-managed route.If you remove this property, API Gateway restores the default values.
- Parameters
authorization_scopes (
Optional
[Sequence
[str
]]) – The authorization scopes supported by this route.authorization_type (
Optional
[str
]) – The authorization type for the route. To learn more, see AuthorizationType .authorizer_id (
Optional
[str
]) – The identifier of theAuthorizer
resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.operation_name (
Optional
[str
]) – The operation name for the route.target (
Optional
[str
]) – For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
- 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_apigatewayv2 as apigatewayv2 route_overrides_property = apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty( authorization_scopes=["authorizationScopes"], authorization_type="authorizationType", authorizer_id="authorizerId", operation_name="operationName", target="target" )
Attributes
The authorization scopes supported by this route.
The authorization type for the route.
To learn more, see AuthorizationType .
The identifier of the
Authorizer
resource to be associated with this route.The authorizer identifier is generated by API Gateway when you created the authorizer.
-
operation_name
¶ The operation name for the route.
-
target
¶ For HTTP integrations, specify a fully qualified URL.
For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
RouteSettingsProperty¶
-
class
CfnApiGatewayManagedOverrides.
RouteSettingsProperty
(*, data_trace_enabled=None, detailed_metrics_enabled=None, logging_level=None, throttling_burst_limit=None, throttling_rate_limit=None)¶ Bases:
object
The
RouteSettings
property overrides the route settings for an API Gateway-managed route.- Parameters
data_trace_enabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether (true
) or not (false
) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.detailed_metrics_enabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether detailed metrics are enabled.logging_level (
Optional
[str
]) – Specifies the logging level for this route:INFO
,ERROR
, orOFF
. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.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_apigatewayv2 as apigatewayv2 route_settings_property = apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 )
Attributes
-
data_trace_enabled
¶ Specifies whether (
true
) or not (false
) data trace logging is enabled for this route.This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
-
detailed_metrics_enabled
¶ Specifies whether detailed metrics are enabled.
-
logging_level
¶ INFO
,ERROR
, orOFF
.This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- Link
- Type
Specifies the logging level for this route
- Return type
Optional
[str
]
-
throttling_burst_limit
¶ Specifies the throttling burst limit.
-
throttling_rate_limit
¶ Specifies the throttling rate limit.
StageOverridesProperty¶
-
class
CfnApiGatewayManagedOverrides.
StageOverridesProperty
(*, access_log_settings=None, auto_deploy=None, default_route_settings=None, description=None, route_settings=None, stage_variables=None)¶ Bases:
object
The
StageOverrides
property overrides the stage configuration for an API Gateway-managed stage.If you remove this property, API Gateway restores the default values.
- Parameters
access_log_settings (
Union
[IResolvable
,AccessLogSettingsProperty
,None
]) – Settings for logging access in a stage.auto_deploy (
Union
[bool
,IResolvable
,None
]) – Specifies whether updates to an API automatically trigger a new deployment. The default value istrue
.default_route_settings (
Union
[IResolvable
,RouteSettingsProperty
,None
]) – The default route settings for the stage.description (
Optional
[str
]) – The description for the API stage.route_settings (
Optional
[Any
]) – Route settings for the stage.stage_variables (
Optional
[Any
]) – A map that defines the stage variables for aStage
. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- 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_apigatewayv2 as apigatewayv2 # route_settings: Any # stage_variables: Any stage_overrides_property = apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty( access_log_settings=apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty( destination_arn="destinationArn", format="format" ), auto_deploy=False, default_route_settings=apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 ), description="description", route_settings=route_settings, stage_variables=stage_variables )
Attributes
-
access_log_settings
¶ Settings for logging access in a stage.
-
auto_deploy
¶ Specifies whether updates to an API automatically trigger a new deployment.
The default value is
true
.
-
default_route_settings
¶ The default route settings for the stage.
-
description
¶ The description for the API stage.
-
route_settings
¶ Route settings for the stage.
-
stage_variables
¶ A map that defines the stage variables for a
Stage
.Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.