We recommend new projects start with resources from the AWS provider.
aws-native.apigatewayv2.RoutingRule
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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
List<Pulumi.
Aws Native. Api Gateway V2. Inputs. Routing Rule Action> - Conditions
List<Pulumi.
Aws Native. Api Gateway V2. Inputs. Routing Rule Condition> - Domain
Name stringArn - The amazon resource name (ARN) of the domain name resource.
- Priority int
- Actions
[]Routing
Rule Action Args - Conditions
[]Routing
Rule Condition Args - Domain
Name stringArn - The amazon resource name (ARN) of the domain name resource.
- Priority int
- actions
List<Routing
Rule Action> - conditions
List<Routing
Rule Condition> - domain
Name StringArn - The amazon resource name (ARN) of the domain name resource.
- priority Integer
- actions
Routing
Rule Action[] - conditions
Routing
Rule Condition[] - domain
Name stringArn - The amazon resource name (ARN) of the domain name resource.
- priority number
- actions
Sequence[Routing
Rule Action Args] - conditions
Sequence[Routing
Rule Condition Args] - domain_
name_ strarn - The amazon resource name (ARN) of the domain name resource.
- priority int
- actions List<Property Map>
- conditions List<Property Map>
- domain
Name StringArn - 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.
- Routing
Rule stringArn - Amazon Resource Name (ARN) of the resource.
- Routing
Rule stringId - RoutingRule Id generated by service
- Id string
- The provider-assigned unique ID for this managed resource.
- Routing
Rule stringArn - Amazon Resource Name (ARN) of the resource.
- Routing
Rule stringId - RoutingRule Id generated by service
- id String
- The provider-assigned unique ID for this managed resource.
- routing
Rule StringArn - Amazon Resource Name (ARN) of the resource.
- routing
Rule StringId - RoutingRule Id generated by service
- id string
- The provider-assigned unique ID for this managed resource.
- routing
Rule stringArn - Amazon Resource Name (ARN) of the resource.
- routing
Rule stringId - RoutingRule Id generated by service
- id str
- The provider-assigned unique ID for this managed resource.
- routing_
rule_ strarn - Amazon Resource Name (ARN) of the resource.
- routing_
rule_ strid - RoutingRule Id generated by service
- id String
- The provider-assigned unique ID for this managed resource.
- routing
Rule StringArn - Amazon Resource Name (ARN) of the resource.
- routing
Rule StringId - RoutingRule Id generated by service
Supporting Types
RoutingRuleAction, RoutingRuleActionArgs
RoutingRuleActionInvokeApi, RoutingRuleActionInvokeApiArgs
- Api
Id string - Stage string
- Strip
Base boolPath
- Api
Id string - Stage string
- Strip
Base boolPath
- api
Id String - stage String
- strip
Base BooleanPath
- api
Id string - stage string
- strip
Base booleanPath
- api_
id str - stage str
- strip_
base_ boolpath
- api
Id String - stage String
- strip
Base BooleanPath
RoutingRuleCondition, RoutingRuleConditionArgs
RoutingRuleMatchBasePaths, RoutingRuleMatchBasePathsArgs
- Any
Of List<string>
- Any
Of []string
- any
Of List<String>
- any
Of string[]
- any_
of Sequence[str]
- any
Of List<String>
RoutingRuleMatchHeaderValue, RoutingRuleMatchHeaderValueArgs
- header str
- value_
glob str
RoutingRuleMatchHeaders, RoutingRuleMatchHeadersArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.