CfnRoute
- class aws_cdk.aws_apigatewayv2.CfnRoute(scope, id, *, api_id, route_key, api_key_required=None, authorization_scopes=None, authorization_type=None, authorizer_id=None, model_selection_expression=None, operation_name=None, request_models=None, request_parameters=None, route_response_selection_expression=None, target=None)
Bases:
CfnResource
A CloudFormation
AWS::ApiGatewayV2::Route
.The
AWS::ApiGatewayV2::Route
resource creates a route for an API.- CloudformationResource:
AWS::ApiGatewayV2::Route
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.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_apigatewayv2 as apigatewayv2 # request_models: Any # request_parameters: Any cfn_route = apigatewayv2.CfnRoute(self, "MyCfnRoute", api_id="apiId", route_key="routeKey", # the properties below are optional api_key_required=False, authorization_scopes=["authorizationScopes"], authorization_type="authorizationType", authorizer_id="authorizerId", model_selection_expression="modelSelectionExpression", operation_name="operationName", request_models=request_models, request_parameters=request_parameters, route_response_selection_expression="routeResponseSelectionExpression", target="target" )
Create a new
AWS::ApiGatewayV2::Route
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
api_id (
str
) – The API identifier.route_key (
str
) – The route key for the route. For HTTP APIs, the route key can be either$default
, or a combination of an HTTP method and resource path, for example,GET /pets
.api_key_required (
Union
[bool
,IResolvable
,None
]) – Specifies whether an API key is required for the route. Supported only for WebSocket APIs.authorization_scopes (
Optional
[Sequence
[str
]]) – The authorization scopes supported by this route.authorization_type (
Optional
[str
]) – The authorization type for the route. For WebSocket APIs, valid values areNONE
for open access,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer. For HTTP APIs, valid values areNONE
for open access,JWT
for using JSON Web Tokens,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer.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.model_selection_expression (
Optional
[str
]) – The model selection expression for the route. Supported only for WebSocket APIs.operation_name (
Optional
[str
]) – The operation name for the route.request_models (
Optional
[Any
]) – The request models for the route. Supported only for WebSocket APIs.request_parameters (
Optional
[Any
]) – The request parameters for the route. Supported only for WebSocket APIs.route_response_selection_expression (
Optional
[str
]) – The route response selection expression for the route. Supported only for WebSocket APIs.target (
Optional
[str
]) – The target for the route.
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
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:
- 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::ApiGatewayV2::Route'
- api_id
The API identifier.
- api_key_required
Specifies whether an API key is required for the route.
Supported only for WebSocket APIs.
- attr_route_id
The route ID.
- CloudformationAttribute:
RouteId
- authorization_scopes
The authorization scopes supported by this route.
- authorization_type
The authorization type for the route.
For WebSocket APIs, valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer. For HTTP APIs, valid values areNONE
for open access,JWT
for using JSON Web Tokens,AWS_IAM
for using AWS IAM permissions, andCUSTOM
for using a Lambda authorizer.
- authorizer_id
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.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- 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.
- model_selection_expression
The model selection expression for the route.
Supported only for WebSocket APIs.
- node
The construct tree node associated with this construct.
- operation_name
The operation name for the route.
- 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 })
.
- request_models
The request models for the route.
Supported only for WebSocket APIs.
- request_parameters
The request parameters for the route.
Supported only for WebSocket APIs.
- route_key
The route key for the route.
For HTTP APIs, the route key can be either
$default
, or a combination of an HTTP method and resource path, for example,GET /pets
.
- route_response_selection_expression
The route response selection expression for the route.
Supported only for WebSocket APIs.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- target
The target for the route.
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
ParameterConstraintsProperty
- class CfnRoute.ParameterConstraintsProperty(*, required)
Bases:
object
- Parameters:
required (
Union
[bool
,IResolvable
]) –CfnRoute.ParameterConstraintsProperty.Required
.- 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 parameter_constraints_property = apigatewayv2.CfnRoute.ParameterConstraintsProperty( required=False )
Attributes
- required
CfnRoute.ParameterConstraintsProperty.Required
.