1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. RoutingRule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

aws-native.apigatewayv2.RoutingRule

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

    Schema for AWS::ApiGatewayV2::RoutingRule

    Create RoutingRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RoutingRule(name: string, args: RoutingRuleArgs, opts?: CustomResourceOptions);
    @overload
    def RoutingRule(resource_name: str,
                    args: RoutingRuleArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def RoutingRule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    actions: Optional[Sequence[RoutingRuleActionArgs]] = None,
                    conditions: Optional[Sequence[RoutingRuleConditionArgs]] = None,
                    domain_name_arn: Optional[str] = None,
                    priority: Optional[int] = None)
    func NewRoutingRule(ctx *Context, name string, args RoutingRuleArgs, opts ...ResourceOption) (*RoutingRule, error)
    public RoutingRule(string name, RoutingRuleArgs args, CustomResourceOptions? opts = null)
    public RoutingRule(String name, RoutingRuleArgs args)
    public RoutingRule(String name, RoutingRuleArgs args, CustomResourceOptions options)
    
    type: aws-native:apigatewayv2:RoutingRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RoutingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RoutingRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RoutingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoutingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoutingRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RoutingRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RoutingRule resource accepts the following input properties:

    Actions []RoutingRuleActionArgs
    Conditions []RoutingRuleConditionArgs
    DomainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    Priority int
    actions List<RoutingRuleAction>
    conditions List<RoutingRuleCondition>
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    priority Integer
    actions RoutingRuleAction[]
    conditions RoutingRuleCondition[]
    domainNameArn string
    The amazon resource name (ARN) of the domain name resource.
    priority number
    actions List<Property Map>
    conditions List<Property Map>
    domainNameArn String
    The amazon resource name (ARN) of the domain name resource.
    priority Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RoutingRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    RoutingRuleId string
    RoutingRule Id generated by service
    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    RoutingRuleId string
    RoutingRule Id generated by service
    id String
    The provider-assigned unique ID for this managed resource.
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.
    routingRuleId String
    RoutingRule Id generated by service
    id string
    The provider-assigned unique ID for this managed resource.
    routingRuleArn string
    Amazon Resource Name (ARN) of the resource.
    routingRuleId string
    RoutingRule Id generated by service
    id str
    The provider-assigned unique ID for this managed resource.
    routing_rule_arn str
    Amazon Resource Name (ARN) of the resource.
    routing_rule_id str
    RoutingRule Id generated by service
    id String
    The provider-assigned unique ID for this managed resource.
    routingRuleArn String
    Amazon Resource Name (ARN) of the resource.
    routingRuleId String
    RoutingRule Id generated by service

    Supporting Types

    RoutingRuleAction, RoutingRuleActionArgs

    RoutingRuleActionInvokeApi, RoutingRuleActionInvokeApiArgs

    ApiId string
    Stage string
    StripBasePath bool
    ApiId string
    Stage string
    StripBasePath bool
    apiId String
    stage String
    stripBasePath Boolean
    apiId string
    stage string
    stripBasePath boolean
    apiId String
    stage String
    stripBasePath Boolean

    RoutingRuleCondition, RoutingRuleConditionArgs

    RoutingRuleMatchBasePaths, RoutingRuleMatchBasePathsArgs

    AnyOf List<string>
    AnyOf []string
    anyOf List<String>
    anyOf string[]
    any_of Sequence[str]
    anyOf List<String>

    RoutingRuleMatchHeaderValue, RoutingRuleMatchHeaderValueArgs

    Header string
    ValueGlob string
    Header string
    ValueGlob string
    header String
    valueGlob String
    header string
    valueGlob string
    header String
    valueGlob String

    RoutingRuleMatchHeaders, RoutingRuleMatchHeadersArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi