Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. getRouterGroup
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

cloudfoundry.getRouterGroup

Explore with Pulumi AI

cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

Gets information on a particular Cloud Foundry router group. Router groups are used to declare TCP domains and need to be referenced when declaring TCP routes.

NOTE: This data source requires the provider to be authenticated with an account granted admin permissions.

Example Usage

The following example looks up a router group named ‘my_custom_router_group’.

import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";

const default_tcp = cloudfoundry.getRouterGroup({
    name: "default-tcp",
});
Copy
import pulumi
import pulumi_cloudfoundry as cloudfoundry

default_tcp = cloudfoundry.get_router_group(name="default-tcp")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfoundry.GetRouterGroup(ctx, &cloudfoundry.GetRouterGroupArgs{
			Name: "default-tcp",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var default_tcp = Cloudfoundry.GetRouterGroup.Invoke(new()
    {
        Name = "default-tcp",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.CloudfoundryFunctions;
import com.pulumi.cloudfoundry.inputs.GetRouterGroupArgs;
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) {
        final var default-tcp = CloudfoundryFunctions.getRouterGroup(GetRouterGroupArgs.builder()
            .name("default-tcp")
            .build());

    }
}
Copy
variables:
  default-tcp:
    fn::invoke:
      function: cloudfoundry:getRouterGroup
      arguments:
        name: default-tcp
Copy

Using getRouterGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRouterGroup(args: GetRouterGroupArgs, opts?: InvokeOptions): Promise<GetRouterGroupResult>
function getRouterGroupOutput(args: GetRouterGroupOutputArgs, opts?: InvokeOptions): Output<GetRouterGroupResult>
Copy
def get_router_group(id: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRouterGroupResult
def get_router_group_output(id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRouterGroupResult]
Copy
func GetRouterGroup(ctx *Context, args *GetRouterGroupArgs, opts ...InvokeOption) (*GetRouterGroupResult, error)
func GetRouterGroupOutput(ctx *Context, args *GetRouterGroupOutputArgs, opts ...InvokeOption) GetRouterGroupResultOutput
Copy

> Note: This function is named GetRouterGroup in the Go SDK.

public static class GetRouterGroup 
{
    public static Task<GetRouterGroupResult> InvokeAsync(GetRouterGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetRouterGroupResult> Invoke(GetRouterGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRouterGroupResult> getRouterGroup(GetRouterGroupArgs args, InvokeOptions options)
public static Output<GetRouterGroupResult> getRouterGroup(GetRouterGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudfoundry:index/getRouterGroup:getRouterGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the router group to look up
Id string
The GUID of the router group
Name This property is required. string
The name of the router group to look up
Id string
The GUID of the router group
name This property is required. String
The name of the router group to look up
id String
The GUID of the router group
name This property is required. string
The name of the router group to look up
id string
The GUID of the router group
name This property is required. str
The name of the router group to look up
id str
The GUID of the router group
name This property is required. String
The name of the router group to look up
id String
The GUID of the router group

getRouterGroup Result

The following output properties are available:

Id string
The GUID of the router group
Name string
Type string
The type of the router group
Id string
The GUID of the router group
Name string
Type string
The type of the router group
id String
The GUID of the router group
name String
type String
The type of the router group
id string
The GUID of the router group
name string
type string
The type of the router group
id str
The GUID of the router group
name str
type str
The type of the router group
id String
The GUID of the router group
name String
type String
The type of the router group

Package Details

Repository
cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
License
Notes
This Pulumi package is based on the cloudfoundry Terraform Provider.
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry