Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. HCP
  3. API Docs
  4. getVaultCluster
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security
grapl-security/pulumi-hcp

hcp.getVaultCluster

Explore with Pulumi AI

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

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

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Hcp = Pulumi.Hcp;

return await Deployment.RunAsync(() => 
{
    var example = Hcp.GetVaultCluster.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.LookupVaultCluster(ctx, &GetVaultClusterArgs{
			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.GetVaultClusterArgs;
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.getVaultCluster(GetVaultClusterArgs.builder()
            .clusterId(var_.cluster_id())
            .build());

    }
}

    import pulumi
import pulumi_hcp as hcp

example = hcp.get_vault_cluster(cluster_id=var["cluster_id"])

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

const example = hcp.getVaultCluster({
    clusterId: _var.cluster_id,
});

    variables:
  example:
    Fn::Invoke:
      Function: hcp:getVaultCluster
      Arguments:
        clusterId: ${var.cluster_id}

    Using getVaultCluster

    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 getVaultCluster(args: GetVaultClusterArgs, opts?: InvokeOptions): Promise<GetVaultClusterResult>
function getVaultClusterOutput(args: GetVaultClusterOutputArgs, opts?: InvokeOptions): Output<GetVaultClusterResult>
    def get_vault_cluster(audit_log_configs: Optional[Sequence[GetVaultClusterAuditLogConfig]] = None,
                      cluster_id: Optional[str] = None,
                      metrics_configs: Optional[Sequence[GetVaultClusterMetricsConfig]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVaultClusterResult
def get_vault_cluster_output(audit_log_configs: Optional[pulumi.Input[Sequence[pulumi.Input[GetVaultClusterAuditLogConfigArgs]]]] = None,
                      cluster_id: Optional[pulumi.Input[str]] = None,
                      metrics_configs: Optional[pulumi.Input[Sequence[pulumi.Input[GetVaultClusterMetricsConfigArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVaultClusterResult]
    func LookupVaultCluster(ctx *Context, args *LookupVaultClusterArgs, opts ...InvokeOption) (*LookupVaultClusterResult, error)
func LookupVaultClusterOutput(ctx *Context, args *LookupVaultClusterOutputArgs, opts ...InvokeOption) LookupVaultClusterResultOutput

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

    public static class GetVaultCluster 
{
    public static Task<GetVaultClusterResult> InvokeAsync(GetVaultClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetVaultClusterResult> Invoke(GetVaultClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVaultClusterResult> getVaultCluster(GetVaultClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: hcp:index/getVaultCluster:getVaultCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The ID of the HCP Vault cluster.
    AuditLogConfigs List<GetVaultClusterAuditLogConfig>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MetricsConfigs List<GetVaultClusterMetricsConfig>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    ClusterId string
    The ID of the HCP Vault cluster.
    AuditLogConfigs []GetVaultClusterAuditLogConfig
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MetricsConfigs []GetVaultClusterMetricsConfig
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    clusterId String
    The ID of the HCP Vault cluster.
    auditLogConfigs List<GetVaultClusterAuditLogConfig>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    metricsConfigs List<GetVaultClusterMetricsConfig>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    clusterId string
    The ID of the HCP Vault cluster.
    auditLogConfigs GetVaultClusterAuditLogConfig[]
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    metricsConfigs GetVaultClusterMetricsConfig[]
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    cluster_id str
    The ID of the HCP Vault cluster.
    audit_log_configs Sequence[GetVaultClusterAuditLogConfig]
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    metrics_configs Sequence[GetVaultClusterMetricsConfig]
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    clusterId String
    The ID of the HCP Vault cluster.
    auditLogConfigs List<Property Map>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    metricsConfigs List<Property Map>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)

    getVaultCluster Result

    The following output properties are available:

    AuditLogConfigs List<GetVaultClusterAuditLogConfig>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    CloudProvider string
    The provider where the HCP Vault cluster is located.
    ClusterId string
    The ID of the HCP Vault cluster.
    CreatedAt string
    The time that the Vault cluster was created.
    HvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MajorVersionUpgradeConfigs List<GetVaultClusterMajorVersionUpgradeConfig>
    MetricsConfigs List<GetVaultClusterMetricsConfig>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MinVaultVersion string
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    Namespace string
    The name of the customer namespace this HCP Vault cluster is located in.
    OrganizationId string
    The ID of the organization this HCP Vault cluster is located in.
    PathsFilters List<string>
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    PrimaryLink string
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    ProjectId string
    The ID of the project this HCP Vault cluster is located in.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    Region string
    The region where the HCP Vault cluster is located.
    SelfLink string
    A unique URL identifying the Vault cluster.
    State string
    The state of the Vault cluster.
    Tier string
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    VaultPrivateEndpointUrl string
    The private URL for the Vault cluster.
    VaultPublicEndpointUrl string
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    VaultVersion string
    The Vault version of the cluster.
    AuditLogConfigs []GetVaultClusterAuditLogConfig
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    CloudProvider string
    The provider where the HCP Vault cluster is located.
    ClusterId string
    The ID of the HCP Vault cluster.
    CreatedAt string
    The time that the Vault cluster was created.
    HvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MajorVersionUpgradeConfigs []GetVaultClusterMajorVersionUpgradeConfig
    MetricsConfigs []GetVaultClusterMetricsConfig
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MinVaultVersion string
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    Namespace string
    The name of the customer namespace this HCP Vault cluster is located in.
    OrganizationId string
    The ID of the organization this HCP Vault cluster is located in.
    PathsFilters []string
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    PrimaryLink string
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    ProjectId string
    The ID of the project this HCP Vault cluster is located in.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    Region string
    The region where the HCP Vault cluster is located.
    SelfLink string
    A unique URL identifying the Vault cluster.
    State string
    The state of the Vault cluster.
    Tier string
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    VaultPrivateEndpointUrl string
    The private URL for the Vault cluster.
    VaultPublicEndpointUrl string
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    VaultVersion string
    The Vault version of the cluster.
    auditLogConfigs List<GetVaultClusterAuditLogConfig>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    cloudProvider String
    The provider where the HCP Vault cluster is located.
    clusterId String
    The ID of the HCP Vault cluster.
    createdAt String
    The time that the Vault cluster was created.
    hvnId String
    The ID of the HVN this HCP Vault cluster is associated to.
    id String
    The provider-assigned unique ID for this managed resource.
    majorVersionUpgradeConfigs List<GetVaultClusterMajorVersionUpgradeConfig>
    metricsConfigs List<GetVaultClusterMetricsConfig>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    minVaultVersion String
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    namespace String
    The name of the customer namespace this HCP Vault cluster is located in.
    organizationId String
    The ID of the organization this HCP Vault cluster is located in.
    pathsFilters List<String>
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    primaryLink String
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    projectId String
    The ID of the project this HCP Vault cluster is located in.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    region String
    The region where the HCP Vault cluster is located.
    selfLink String
    A unique URL identifying the Vault cluster.
    state String
    The state of the Vault cluster.
    tier String
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    vaultPrivateEndpointUrl String
    The private URL for the Vault cluster.
    vaultPublicEndpointUrl String
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    vaultVersion String
    The Vault version of the cluster.
    auditLogConfigs GetVaultClusterAuditLogConfig[]
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    cloudProvider string
    The provider where the HCP Vault cluster is located.
    clusterId string
    The ID of the HCP Vault cluster.
    createdAt string
    The time that the Vault cluster was created.
    hvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    id string
    The provider-assigned unique ID for this managed resource.
    majorVersionUpgradeConfigs GetVaultClusterMajorVersionUpgradeConfig[]
    metricsConfigs GetVaultClusterMetricsConfig[]
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    minVaultVersion string
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    namespace string
    The name of the customer namespace this HCP Vault cluster is located in.
    organizationId string
    The ID of the organization this HCP Vault cluster is located in.
    pathsFilters string[]
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    primaryLink string
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    projectId string
    The ID of the project this HCP Vault cluster is located in.
    publicEndpoint boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    region string
    The region where the HCP Vault cluster is located.
    selfLink string
    A unique URL identifying the Vault cluster.
    state string
    The state of the Vault cluster.
    tier string
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    vaultPrivateEndpointUrl string
    The private URL for the Vault cluster.
    vaultPublicEndpointUrl string
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    vaultVersion string
    The Vault version of the cluster.
    audit_log_configs Sequence[GetVaultClusterAuditLogConfig]
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    cloud_provider str
    The provider where the HCP Vault cluster is located.
    cluster_id str
    The ID of the HCP Vault cluster.
    created_at str
    The time that the Vault cluster was created.
    hvn_id str
    The ID of the HVN this HCP Vault cluster is associated to.
    id str
    The provider-assigned unique ID for this managed resource.
    major_version_upgrade_configs Sequence[GetVaultClusterMajorVersionUpgradeConfig]
    metrics_configs Sequence[GetVaultClusterMetricsConfig]
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    min_vault_version str
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    namespace str
    The name of the customer namespace this HCP Vault cluster is located in.
    organization_id str
    The ID of the organization this HCP Vault cluster is located in.
    paths_filters Sequence[str]
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    primary_link str
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    project_id str
    The ID of the project this HCP Vault cluster is located in.
    public_endpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    region str
    The region where the HCP Vault cluster is located.
    self_link str
    A unique URL identifying the Vault cluster.
    state str
    The state of the Vault cluster.
    tier str
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    vault_private_endpoint_url str
    The private URL for the Vault cluster.
    vault_public_endpoint_url str
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    vault_version str
    The Vault version of the cluster.
    auditLogConfigs List<Property Map>
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    cloudProvider String
    The provider where the HCP Vault cluster is located.
    clusterId String
    The ID of the HCP Vault cluster.
    createdAt String
    The time that the Vault cluster was created.
    hvnId String
    The ID of the HVN this HCP Vault cluster is associated to.
    id String
    The provider-assigned unique ID for this managed resource.
    majorVersionUpgradeConfigs List<Property Map>
    metricsConfigs List<Property Map>
    The metrics configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    minVaultVersion String
    The minimum Vault version to use when creating the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    namespace String
    The name of the customer namespace this HCP Vault cluster is located in.
    organizationId String
    The ID of the organization this HCP Vault cluster is located in.
    pathsFilters List<String>
    The performance replication paths filter. Applies to performance replication secondaries only and operates in "deny" mode only.
    primaryLink String
    The self_link of the HCP Vault Plus tier cluster which is the primary in the performance replication setup with this HCP Vault Plus tier cluster. If not specified, it is a standalone Plus tier HCP Vault cluster.
    projectId String
    The ID of the project this HCP Vault cluster is located in.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    region String
    The region where the HCP Vault cluster is located.
    selfLink String
    A unique URL identifying the Vault cluster.
    state String
    The state of the Vault cluster.
    tier String
    The tier that the HCP Vault cluster will be provisioned as. Only 'development' is available at this time.
    vaultPrivateEndpointUrl String
    The private URL for the Vault cluster.
    vaultPublicEndpointUrl String
    The public URL for the Vault cluster. This will be empty if public_endpoint is false.
    vaultVersion String
    The Vault version of the cluster.

    Supporting Types

    GetVaultClusterAuditLogConfig

    DatadogRegion string
    Datadog region for streaming audit logs
    GrafanaEndpoint string
    Grafana endpoint for streaming audit logs
    GrafanaUser string
    Grafana user for streaming audit logs
    SplunkHecendpoint string
    Splunk endpoint for streaming audit logs
    DatadogRegion string
    Datadog region for streaming audit logs
    GrafanaEndpoint string
    Grafana endpoint for streaming audit logs
    GrafanaUser string
    Grafana user for streaming audit logs
    SplunkHecendpoint string
    Splunk endpoint for streaming audit logs
    datadogRegion String
    Datadog region for streaming audit logs
    grafanaEndpoint String
    Grafana endpoint for streaming audit logs
    grafanaUser String
    Grafana user for streaming audit logs
    splunkHecendpoint String
    Splunk endpoint for streaming audit logs
    datadogRegion string
    Datadog region for streaming audit logs
    grafanaEndpoint string
    Grafana endpoint for streaming audit logs
    grafanaUser string
    Grafana user for streaming audit logs
    splunkHecendpoint string
    Splunk endpoint for streaming audit logs
    datadog_region str
    Datadog region for streaming audit logs
    grafana_endpoint str
    Grafana endpoint for streaming audit logs
    grafana_user str
    Grafana user for streaming audit logs
    splunk_hecendpoint str
    Splunk endpoint for streaming audit logs
    datadogRegion String
    Datadog region for streaming audit logs
    grafanaEndpoint String
    Grafana endpoint for streaming audit logs
    grafanaUser String
    Grafana user for streaming audit logs
    splunkHecendpoint String
    Splunk endpoint for streaming audit logs

    GetVaultClusterMajorVersionUpgradeConfig

    GetVaultClusterMetricsConfig

    DatadogRegion string
    Datadog region for streaming metrics
    GrafanaEndpoint string
    Grafana endpoint for streaming metrics
    GrafanaUser string
    Grafana user for streaming metrics
    SplunkHecendpoint string
    Splunk endpoint for streaming metrics
    DatadogRegion string
    Datadog region for streaming metrics
    GrafanaEndpoint string
    Grafana endpoint for streaming metrics
    GrafanaUser string
    Grafana user for streaming metrics
    SplunkHecendpoint string
    Splunk endpoint for streaming metrics
    datadogRegion String
    Datadog region for streaming metrics
    grafanaEndpoint String
    Grafana endpoint for streaming metrics
    grafanaUser String
    Grafana user for streaming metrics
    splunkHecendpoint String
    Splunk endpoint for streaming metrics
    datadogRegion string
    Datadog region for streaming metrics
    grafanaEndpoint string
    Grafana endpoint for streaming metrics
    grafanaUser string
    Grafana user for streaming metrics
    splunkHecendpoint string
    Splunk endpoint for streaming metrics
    datadog_region str
    Datadog region for streaming metrics
    grafana_endpoint str
    Grafana endpoint for streaming metrics
    grafana_user str
    Grafana user for streaming metrics
    splunk_hecendpoint str
    Splunk endpoint for streaming metrics
    datadogRegion String
    Datadog region for streaming metrics
    grafanaEndpoint String
    Grafana endpoint for streaming metrics
    grafanaUser String
    Grafana user for streaming metrics
    splunkHecendpoint String
    Splunk endpoint for streaming metrics

    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
    grapl-security/pulumi-hcp