CfnRoutingRule

class aws_cdk.aws_apigatewayv2.CfnRoutingRule(scope, id, *, actions, conditions, domain_name_arn, priority)

Bases: CfnResource

Represents a routing rule.

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html
CloudformationResource:: AWS::ApiGatewayV2::RoutingRule
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

cfn_routing_rule = apigatewayv2.CfnRoutingRule(self, "MyCfnRoutingRule",
    actions=[apigatewayv2.CfnRoutingRule.ActionProperty(
        invoke_api=apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty(
            api_id="apiId",
            stage="stage",

            # the properties below are optional
            strip_base_path=False
        )
    )],
    conditions=[apigatewayv2.CfnRoutingRule.ConditionProperty(
        match_base_paths=apigatewayv2.CfnRoutingRule.MatchBasePathsProperty(
            any_of=["anyOf"]
        ),
        match_headers=apigatewayv2.CfnRoutingRule.MatchHeadersProperty(
            any_of=[apigatewayv2.CfnRoutingRule.MatchHeaderValueProperty(
                header="header",
                value_glob="valueGlob"
            )]
        )
    )],
    domain_name_arn="domainNameArn",
    priority=123
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty, Dict[str, Any]]]]) – The resulting action based on matching a routing rules condition. Only InvokeApi is supported.
conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]]]) – The conditions of the routing rule.
domain_name_arn (str) – The ARN of the domain name.
priority (Union[int, float]) – The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can’t have the same priority. Priority values 1-1,000,000 are supported.

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_dependency(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_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
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 prefix path 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 to addOverride 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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::RoutingRule'

actions: The resulting action based on matching a routing rules condition.

attr_routing_rule_arn

Represents an Amazon Resource Name (ARN).

CloudformationAttribute:: RoutingRuleArn

attr_routing_rule_id

The identifier.

CloudformationAttribute:: RoutingRuleId

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

conditions: The conditions of the routing rule.

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.

domain_name_arn: The ARN of the domain name.

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.

node: The tree node.

priority: The order in which API Gateway evaluates a rule.

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 }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

ActionInvokeApiProperty

class CfnRoutingRule.ActionInvokeApiProperty(*, api_id, stage, strip_base_path=None)

Bases: object

Represents an InvokeApi action.

Parameters:

api_id (str) – The API identifier of the target API.
stage (str) – The name of the target stage.
strip_base_path (Union[bool, IResolvable, None]) – The strip base path setting. When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

action_invoke_api_property = apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty(
    api_id="apiId",
    stage="stage",

    # the properties below are optional
    strip_base_path=False
)

Attributes

api_id

The API identifier of the target API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-apiid

stage

The name of the target stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-stage

strip_base_path

The strip base path setting.

When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-actioninvokeapi.html#cfn-apigatewayv2-routingrule-actioninvokeapi-stripbasepath

ActionProperty

class CfnRoutingRule.ActionProperty(*, invoke_api)

Bases: object

Represents a routing rule action.

The only supported action is invokeApi .

Parameters:: invoke_api (Union[IResolvable, ActionInvokeApiProperty, Dict[str, Any]]) – Represents an InvokeApi action.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-action.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

action_property = apigatewayv2.CfnRoutingRule.ActionProperty(
    invoke_api=apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty(
        api_id="apiId",
        stage="stage",

        # the properties below are optional
        strip_base_path=False
    )
)

Attributes

invoke_api

Represents an InvokeApi action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-action.html#cfn-apigatewayv2-routingrule-action-invokeapi

ConditionProperty

class CfnRoutingRule.ConditionProperty(*, match_base_paths=None, match_headers=None)

Bases: object

Represents a condition.

Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

Parameters:

match_base_paths (Union[IResolvable, MatchBasePathsProperty, Dict[str, Any], None]) – The base path to be matched.
match_headers (Union[IResolvable, MatchHeadersProperty, Dict[str, Any], None]) – The headers to be matched.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

condition_property = apigatewayv2.CfnRoutingRule.ConditionProperty(
    match_base_paths=apigatewayv2.CfnRoutingRule.MatchBasePathsProperty(
        any_of=["anyOf"]
    ),
    match_headers=apigatewayv2.CfnRoutingRule.MatchHeadersProperty(
        any_of=[apigatewayv2.CfnRoutingRule.MatchHeaderValueProperty(
            header="header",
            value_glob="valueGlob"
        )]
    )
)

Attributes

match_base_paths

The base path to be matched.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchbasepaths

match_headers

The headers to be matched.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchheaders

MatchBasePathsProperty

class CfnRoutingRule.MatchBasePathsProperty(*, any_of)

Bases: object

Represents a MatchBasePaths condition.

Parameters:: any_of (Sequence[str]) – The string of the case sensitive base path to be matched.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchbasepaths.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

match_base_paths_property = apigatewayv2.CfnRoutingRule.MatchBasePathsProperty(
    any_of=["anyOf"]
)

Attributes

any_of

The string of the case sensitive base path to be matched.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchbasepaths.html#cfn-apigatewayv2-routingrule-matchbasepaths-anyof

MatchHeaderValueProperty

class CfnRoutingRule.MatchHeaderValueProperty(*, header, value_glob)

Bases: object

Represents a MatchHeaderValue .

Parameters:

header (str) – The case insensitive header name to be matched. The header name must be less than 40 characters and the only allowed characters are a-z , A-Z , 0-9 , and the following special characters: ``*?-!#$%&’.^_``|~.` .
value_glob (str) – The case sensitive header glob value to be matched against entire header value. The header glob value must be less than 128 characters and the only allowed characters are a-z , A-Z , 0-9 , and the following special characters: *?-!#$%&'.^_``|~. Wildcard matching is supported for header glob values but must be for``*prefix-match``,``suffix-match*``, or``*infix*-match` .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

match_header_value_property = apigatewayv2.CfnRoutingRule.MatchHeaderValueProperty(
    header="header",
    value_glob="valueGlob"
)

Attributes

header

The case insensitive header name to be matched.

The header name must be less than 40 characters and the only allowed characters are a-z , A-Z , 0-9 , and the following special characters: ``*?-!#$%&’.^_``|~.` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html#cfn-apigatewayv2-routingrule-matchheadervalue-header

value_glob

The case sensitive header glob value to be matched against entire header value.

The header glob value must be less than 128 characters and the only allowed characters are a-z , A-Z , 0-9 , and the following special characters: *?-!#$%&'.^_``|~. Wildcard matching is supported for header glob values but must be for``*prefix-match``,``suffix-match*``, or``*infix*-match` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheadervalue.html#cfn-apigatewayv2-routingrule-matchheadervalue-valueglob

MatchHeadersProperty

class CfnRoutingRule.MatchHeadersProperty(*, any_of)

Bases: object

Represents a MatchHeaders condition.

Parameters:: any_of (Union[IResolvable, Sequence[Union[IResolvable, MatchHeaderValueProperty, Dict[str, Any]]]]) – The header name and header value glob to be matched. The matchHeaders condition is matched if any of the header name and header value globs are matched.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheaders.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

match_headers_property = apigatewayv2.CfnRoutingRule.MatchHeadersProperty(
    any_of=[apigatewayv2.CfnRoutingRule.MatchHeaderValueProperty(
        header="header",
        value_glob="valueGlob"
    )]
)

Attributes

any_of

The header name and header value glob to be matched.

The matchHeaders condition is matched if any of the header name and header value globs are matched.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-matchheaders.html#cfn-apigatewayv2-routingrule-matchheaders-anyof