Package com.pulumi.gcp.networkservices

Class TcpRoute

  • public class TcpRoute
extends com.pulumi.resources.CustomResource
    ## Example Usage ### Network Services Tcp Route Basic ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HttpHealthCheck; import com.pulumi.gcp.compute.HttpHealthCheckArgs; import com.pulumi.gcp.compute.BackendService; import com.pulumi.gcp.compute.BackendServiceArgs; import com.pulumi.gcp.networkservices.TcpRoute; import com.pulumi.gcp.networkservices.TcpRouteArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleActionArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; 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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder() .requestPath("/") .checkIntervalSec(1) .timeoutSec(1) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder() .healthChecks(defaultHttpHealthCheck.id()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultTcpRoute = new TcpRoute("defaultTcpRoute", TcpRouteArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .rules(TcpRouteRuleArgs.builder() .matches(TcpRouteRuleMatchArgs.builder() .address("10.0.0.1/32") .port("8081") .build()) .action(TcpRouteRuleActionArgs.builder() .destinations(TcpRouteRuleActionDestinationArgs.builder() .serviceName(defaultBackendService.id()) .weight(1) .build()) .originalDestination(false) .build()) .build()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); } } ``` ### Network Services Tcp Route Actions ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HttpHealthCheck; import com.pulumi.gcp.compute.HttpHealthCheckArgs; import com.pulumi.gcp.compute.BackendService; import com.pulumi.gcp.compute.BackendServiceArgs; import com.pulumi.gcp.networkservices.TcpRoute; import com.pulumi.gcp.networkservices.TcpRouteArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleActionArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; 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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder() .requestPath("/") .checkIntervalSec(1) .timeoutSec(1) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder() .healthChecks(defaultHttpHealthCheck.id()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultTcpRoute = new TcpRoute("defaultTcpRoute", TcpRouteArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .rules(TcpRouteRuleArgs.builder() .action(TcpRouteRuleActionArgs.builder() .destinations(TcpRouteRuleActionDestinationArgs.builder() .serviceName(defaultBackendService.id()) .weight(1) .build()) .originalDestination(false) .build()) .build()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); } } ``` ### Network Services Tcp Route Mesh Basic ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HttpHealthCheck; import com.pulumi.gcp.compute.HttpHealthCheckArgs; import com.pulumi.gcp.compute.BackendService; import com.pulumi.gcp.compute.BackendServiceArgs; import com.pulumi.gcp.networkservices.Mesh; import com.pulumi.gcp.networkservices.MeshArgs; import com.pulumi.gcp.networkservices.TcpRoute; import com.pulumi.gcp.networkservices.TcpRouteArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleActionArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; 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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder() .requestPath("/") .checkIntervalSec(1) .timeoutSec(1) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder() .healthChecks(defaultHttpHealthCheck.id()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultMesh = new Mesh("defaultMesh", MeshArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultTcpRoute = new TcpRoute("defaultTcpRoute", TcpRouteArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .meshes(defaultMesh.id()) .rules(TcpRouteRuleArgs.builder() .matches(TcpRouteRuleMatchArgs.builder() .address("10.0.0.1/32") .port("8081") .build()) .action(TcpRouteRuleActionArgs.builder() .destinations(TcpRouteRuleActionDestinationArgs.builder() .serviceName(defaultBackendService.id()) .weight(1) .build()) .originalDestination(false) .build()) .build()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); } } ``` ### Network Services Tcp Route Gateway Basic ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HttpHealthCheck; import com.pulumi.gcp.compute.HttpHealthCheckArgs; import com.pulumi.gcp.compute.BackendService; import com.pulumi.gcp.compute.BackendServiceArgs; import com.pulumi.gcp.networkservices.Gateway; import com.pulumi.gcp.networkservices.GatewayArgs; import com.pulumi.gcp.networkservices.TcpRoute; import com.pulumi.gcp.networkservices.TcpRouteArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleArgs; import com.pulumi.gcp.networkservices.inputs.TcpRouteRuleActionArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; 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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder() .requestPath("/") .checkIntervalSec(1) .timeoutSec(1) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder() .healthChecks(defaultHttpHealthCheck.id()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultGateway = new Gateway("defaultGateway", GatewayArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .scope("my-scope") .type("OPEN_MESH") .ports(443) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); var defaultTcpRoute = new TcpRoute("defaultTcpRoute", TcpRouteArgs.builder() .labels(Map.of("foo", "bar")) .description("my description") .gateways(defaultGateway.id()) .rules(TcpRouteRuleArgs.builder() .matches(TcpRouteRuleMatchArgs.builder() .address("10.0.0.1/32") .port("8081") .build()) .action(TcpRouteRuleActionArgs.builder() .destinations(TcpRouteRuleActionDestinationArgs.builder() .serviceName(defaultBackendService.id()) .weight(1) .build()) .originalDestination(false) .build()) .build()) .build(), CustomResourceOptions.builder() .provider(google_beta) .build()); } } ``` ## Import TcpRoute can be imported using any of these accepted formats* `projects/{{project}}/locations/global/tcpRoutes/{{name}}` * `{{project}}/{{name}}` * `{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import TcpRoute using one of the formats above. For exampletf import { id = "projects/{{project}}/locations/global/tcpRoutes/{{name}}" to = google_network_services_tcp_route.default } ```sh $ pulumi import gcp:networkservices/tcpRoute:TcpRoute When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), TcpRoute can be imported using one of the formats above. For example ``` ```sh $ pulumi import gcp:networkservices/tcpRoute:TcpRoute default projects/{{project}}/locations/global/tcpRoutes/{{name}} ``` ```sh $ pulumi import gcp:networkservices/tcpRoute:TcpRoute default {{project}}/{{name}} ``` ```sh $ pulumi import gcp:networkservices/tcpRoute:TcpRoute default {{name}} ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      TcpRoute​(java.lang.String name)  
      TcpRoute​(java.lang.String name, TcpRouteArgs args)  
      TcpRoute​(java.lang.String name, TcpRouteArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> createTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> effectiveLabels()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> gateways()  
      static TcpRoute get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TcpRouteState 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.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> labels()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> meshes()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> pulumiLabels()  
      com.pulumi.core.Output<java.util.List<TcpRouteRule>> rules()  
      com.pulumi.core.Output<java.lang.String> selfLink()  
      com.pulumi.core.Output<java.lang.String> updateTime()  

      • 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

      • TcpRoute

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

      • TcpRoute

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

      • TcpRoute

        public TcpRoute​(java.lang.String name,
                TcpRouteArgs 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

      • createTime

        public com.pulumi.core.Output<java.lang.String> createTime()
        Returns:
        Time the TcpRoute was created in UTC.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A free-text description of the resource. Max length 1024 characters.

      • effectiveLabels

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> effectiveLabels()
        Returns:
        All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

      • gateways

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> gateways()
        Returns:
        Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

      • labels

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> labels()
        Returns:
        Set of label tags associated with the TcpRoute resource. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource.

      • meshes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> meshes()
        Returns:
        Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the TcpRoute resource.

      • project

        public com.pulumi.core.Output<java.lang.String> project()
        Returns:
        The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

      • pulumiLabels

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> pulumiLabels()
        Returns:
        The combination of labels configured directly on the resource and default labels configured on the provider.

      • rules

        public com.pulumi.core.Output<java.util.List<TcpRouteRule>> rules()
        Returns:
        Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. Structure is documented below.

      • selfLink

        public com.pulumi.core.Output<java.lang.String> selfLink()
        Returns:
        Server-defined URL of this resource.

      • updateTime

        public com.pulumi.core.Output<java.lang.String> updateTime()
        Returns:
        Time the TcpRoute was updated in UTC.

      • get

        public static TcpRoute get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           TcpRouteState 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.