Package com.pulumi.aws.apigatewayv2

Class RoutingRule

  • public class RoutingRule
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS API Gateway V2 Routing Rule. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.apigatewayv2.RoutingRule;
 import com.pulumi.aws.apigatewayv2.RoutingRuleArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleActionArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleActionInvokeApiArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleConditionArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleConditionMatchHeadersArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleConditionMatchHeadersAnyOfArgs;
 import com.pulumi.aws.apigatewayv2.inputs.RoutingRuleConditionMatchBasePathsArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new RoutingRule("example", RoutingRuleArgs.builder()
             .actions(RoutingRuleActionArgs.builder()
                 .invokeApi(RoutingRuleActionInvokeApiArgs.builder()
                     .apiId("example-api-id")
                     .stage("example-stage")
                     .stripBasePath(true)
                     .build())
                 .build())
             .conditions(RoutingRuleConditionArgs.builder()
                 .matchHeaders(RoutingRuleConditionMatchHeadersArgs.builder()
                     .anyOf(RoutingRuleConditionMatchHeadersAnyOfArgs.builder()
                         .header("X-Example-Header")
                         .valueGlob("example-value-*")
                         .build())
                     .build())
                 .matchBasePaths(RoutingRuleConditionMatchBasePathsArgs.builder()
                     .anyOfs(                    
                         "example-path",
                         "another-path")
                     .build())
                 .build())
             .domainName("test.example.com")
             .priority(1)
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import API Gateway V2 Routing Rule using the `routingRuleArn`. For example: ```sh $ pulumi import aws:apigatewayv2/routingRule:RoutingRule example arn:aws:apigateway:us-east-1:123456789012:/domainnames/example.com/routingrules/rule1 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<RoutingRuleAction>> actions()  
      com.pulumi.core.Output<java.util.List<RoutingRuleCondition>> conditions()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      static RoutingRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RoutingRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Integer> priority()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> routingRuleArn()  
      com.pulumi.core.Output<java.lang.String> routingRuleId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RoutingRule

        public RoutingRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • RoutingRule

        public RoutingRule​(java.lang.String name,
                   RoutingRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • RoutingRule

        public RoutingRule​(java.lang.String name,
                   RoutingRuleArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • actions

        public com.pulumi.core.Output<java.util.List<RoutingRuleAction>> actions()
        Returns:
        Configuration of resulting action based on matching routing rules condition. See below.

      • conditions

        public com.pulumi.core.Output<java.util.List<RoutingRuleCondition>> conditions()
        Returns:
        Conditions configuration. See below.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Domain name. Must be between 1 and 512 characters in length. The following arguments are optional:

      • priority

        public com.pulumi.core.Output<java.lang.Integer> priority()
        Returns:
        Order of rule evaluation. Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Value must be between 1 and 1,000,000.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • routingRuleArn

        public com.pulumi.core.Output<java.lang.String> routingRuleArn()
        Returns:
        ARN of the Routing Rule.

      • routingRuleId

        public com.pulumi.core.Output<java.lang.String> routingRuleId()
        Returns:
        ID of the Routing Rule.

      • get

        public static RoutingRule get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              RoutingRuleState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.