1. Packages
  2. StrongDM
  3. API Docs
  4. getProxyClusterKey
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

sdm.getProxyClusterKey

Explore with Pulumi AI

sdm logo
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    Proxy Cluster Keys are authentication keys for all proxies within a cluster. The proxies within a cluster share the same key. One cluster can have multiple keys in order to facilitate key rotation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdm from "@pulumi/sdm";
    
    const proxyClusterKeyQuery = sdm.getProxyClusterKey({
        proxyClusterId: "n-233332245",
    });
    
    import pulumi
    import pulumi_sdm as sdm
    
    proxy_cluster_key_query = sdm.get_proxy_cluster_key(proxy_cluster_id="n-233332245")
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-sdm/sdk/go/sdm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdm.LookupProxyClusterKey(ctx, &sdm.LookupProxyClusterKeyArgs{
    			ProxyClusterId: pulumi.StringRef("n-233332245"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdm = Pulumi.Sdm;
    
    return await Deployment.RunAsync(() => 
    {
        var proxyClusterKeyQuery = Sdm.GetProxyClusterKey.Invoke(new()
        {
            ProxyClusterId = "n-233332245",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdm.SdmFunctions;
    import com.pulumi.sdm.inputs.GetProxyClusterKeyArgs;
    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 proxyClusterKeyQuery = SdmFunctions.getProxyClusterKey(GetProxyClusterKeyArgs.builder()
                .proxyClusterId("n-233332245")
                .build());
    
        }
    }
    
    variables:
      proxyClusterKeyQuery:
        fn::invoke:
          Function: sdm:getProxyClusterKey
          Arguments:
            proxyClusterId: n-233332245
    

    Using getProxyClusterKey

    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 getProxyClusterKey(args: GetProxyClusterKeyArgs, opts?: InvokeOptions): Promise<GetProxyClusterKeyResult>
    function getProxyClusterKeyOutput(args: GetProxyClusterKeyOutputArgs, opts?: InvokeOptions): Output<GetProxyClusterKeyResult>
    def get_proxy_cluster_key(id: Optional[str] = None,
                              proxy_cluster_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetProxyClusterKeyResult
    def get_proxy_cluster_key_output(id: Optional[pulumi.Input[str]] = None,
                              proxy_cluster_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetProxyClusterKeyResult]
    func LookupProxyClusterKey(ctx *Context, args *LookupProxyClusterKeyArgs, opts ...InvokeOption) (*LookupProxyClusterKeyResult, error)
    func LookupProxyClusterKeyOutput(ctx *Context, args *LookupProxyClusterKeyOutputArgs, opts ...InvokeOption) LookupProxyClusterKeyResultOutput

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

    public static class GetProxyClusterKey 
    {
        public static Task<GetProxyClusterKeyResult> InvokeAsync(GetProxyClusterKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetProxyClusterKeyResult> Invoke(GetProxyClusterKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProxyClusterKeyResult> getProxyClusterKey(GetProxyClusterKeyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: sdm:index/getProxyClusterKey:getProxyClusterKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.
    id string
    Unique identifier of the Relay.
    proxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    id str
    Unique identifier of the Relay.
    proxy_cluster_id str
    The ID of the proxy cluster which this key authenticates to.
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.

    getProxyClusterKey Result

    The following output properties are available:

    Ids List<string>
    a list of strings of ids of data sources that match the given arguments.
    ProxyClusterKeys List<PiersKarsenbarg.Sdm.Outputs.GetProxyClusterKeyProxyClusterKey>
    A list where each element has the following attributes:
    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    Ids []string
    a list of strings of ids of data sources that match the given arguments.
    ProxyClusterKeys []GetProxyClusterKeyProxyClusterKey
    A list where each element has the following attributes:
    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    proxyClusterKeys List<GetProxyClusterKeyProxyClusterKey>
    A list where each element has the following attributes:
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.
    ids string[]
    a list of strings of ids of data sources that match the given arguments.
    proxyClusterKeys GetProxyClusterKeyProxyClusterKey[]
    A list where each element has the following attributes:
    id string
    Unique identifier of the Relay.
    proxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    ids Sequence[str]
    a list of strings of ids of data sources that match the given arguments.
    proxy_cluster_keys Sequence[GetProxyClusterKeyProxyClusterKey]
    A list where each element has the following attributes:
    id str
    Unique identifier of the Relay.
    proxy_cluster_id str
    The ID of the proxy cluster which this key authenticates to.
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    proxyClusterKeys List<Property Map>
    A list where each element has the following attributes:
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.

    Supporting Types

    GetProxyClusterKeyProxyClusterKey

    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    Id string
    Unique identifier of the Relay.
    ProxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.
    id string
    Unique identifier of the Relay.
    proxyClusterId string
    The ID of the proxy cluster which this key authenticates to.
    id str
    Unique identifier of the Relay.
    proxy_cluster_id str
    The ID of the proxy cluster which this key authenticates to.
    id String
    Unique identifier of the Relay.
    proxyClusterId String
    The ID of the proxy cluster which this key authenticates to.

    Package Details

    Repository
    sdm pierskarsenbarg/pulumi-sdm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdm Terraform Provider.
    sdm logo
    StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg