1. Packages
  2. HCP
  3. API Docs
  4. getBoundaryCluster
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

hcp.getBoundaryCluster

Explore with Pulumi AI

hcp logo
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

    The Boundary cluster data source provides information about an existing HCP Boundary cluster.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Hcp = Pulumi.Hcp;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Hcp.GetBoundaryCluster.Invoke(new()
        {
            ClusterId = @var.Cluster_id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/grapl-security/pulumi-hcp/sdk/go/hcp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hcp.LookupBoundaryCluster(ctx, &GetBoundaryClusterArgs{
    			ClusterId: _var.Cluster_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hcp.HcpFunctions;
    import com.pulumi.hcp.inputs.GetBoundaryClusterArgs;
    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 example = HcpFunctions.getBoundaryCluster(GetBoundaryClusterArgs.builder()
                .clusterId(var_.cluster_id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_hcp as hcp
    
    example = hcp.get_boundary_cluster(cluster_id=var["cluster_id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as hcp from "@pulumi/hcp";
    
    const example = hcp.getBoundaryCluster({
        clusterId: _var.cluster_id,
    });
    
    variables:
      example:
        Fn::Invoke:
          Function: hcp:getBoundaryCluster
          Arguments:
            clusterId: ${var.cluster_id}
    

    Using getBoundaryCluster

    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 getBoundaryCluster(args: GetBoundaryClusterArgs, opts?: InvokeOptions): Promise<GetBoundaryClusterResult>
    function getBoundaryClusterOutput(args: GetBoundaryClusterOutputArgs, opts?: InvokeOptions): Output<GetBoundaryClusterResult>
    def get_boundary_cluster(cluster_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetBoundaryClusterResult
    def get_boundary_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetBoundaryClusterResult]
    func LookupBoundaryCluster(ctx *Context, args *LookupBoundaryClusterArgs, opts ...InvokeOption) (*LookupBoundaryClusterResult, error)
    func LookupBoundaryClusterOutput(ctx *Context, args *LookupBoundaryClusterOutputArgs, opts ...InvokeOption) LookupBoundaryClusterResultOutput

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

    public static class GetBoundaryCluster 
    {
        public static Task<GetBoundaryClusterResult> InvokeAsync(GetBoundaryClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetBoundaryClusterResult> Invoke(GetBoundaryClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBoundaryClusterResult> getBoundaryCluster(GetBoundaryClusterArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: hcp:index/getBoundaryCluster:getBoundaryCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The ID of the Boundary cluster
    ClusterId string
    The ID of the Boundary cluster
    clusterId String
    The ID of the Boundary cluster
    clusterId string
    The ID of the Boundary cluster
    cluster_id str
    The ID of the Boundary cluster
    clusterId String
    The ID of the Boundary cluster

    getBoundaryCluster Result

    The following output properties are available:

    ClusterId string
    The ID of the Boundary cluster
    ClusterUrl string
    A unique URL identifying the Boundary cluster.
    CreatedAt string
    The time that the Boundary cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the Boundary cluster.
    ClusterId string
    The ID of the Boundary cluster
    ClusterUrl string
    A unique URL identifying the Boundary cluster.
    CreatedAt string
    The time that the Boundary cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the Boundary cluster.
    clusterId String
    The ID of the Boundary cluster
    clusterUrl String
    A unique URL identifying the Boundary cluster.
    createdAt String
    The time that the Boundary cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the Boundary cluster.
    clusterId string
    The ID of the Boundary cluster
    clusterUrl string
    A unique URL identifying the Boundary cluster.
    createdAt string
    The time that the Boundary cluster was created.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the Boundary cluster.
    cluster_id str
    The ID of the Boundary cluster
    cluster_url str
    A unique URL identifying the Boundary cluster.
    created_at str
    The time that the Boundary cluster was created.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The state of the Boundary cluster.
    clusterId String
    The ID of the Boundary cluster
    clusterUrl String
    A unique URL identifying the Boundary cluster.
    createdAt String
    The time that the Boundary cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the Boundary cluster.

    Package Details

    Repository
    hcp grapl-security/pulumi-hcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcp Terraform Provider.
    hcp logo
    HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security