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

hcp.VaultCluster

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

    Import

    The import ID is {cluster_id}

     $ pulumi import hcp:index/vaultCluster:VaultCluster example vault-cluster

    Create VaultCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VaultCluster(name: string, args: VaultClusterArgs, opts?: CustomResourceOptions);
    @overload
def VaultCluster(resource_name: str,
                 args: VaultClusterArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def VaultCluster(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_id: Optional[str] = None,
                 hvn_id: Optional[str] = None,
                 audit_log_config: Optional[VaultClusterAuditLogConfigArgs] = None,
                 major_version_upgrade_config: Optional[VaultClusterMajorVersionUpgradeConfigArgs] = None,
                 metrics_config: Optional[VaultClusterMetricsConfigArgs] = None,
                 min_vault_version: Optional[str] = None,
                 paths_filters: Optional[Sequence[str]] = None,
                 primary_link: Optional[str] = None,
                 public_endpoint: Optional[bool] = None,
                 tier: Optional[str] = None)
    func NewVaultCluster(ctx *Context, name string, args VaultClusterArgs, opts ...ResourceOption) (*VaultCluster, error)
    public VaultCluster(string name, VaultClusterArgs args, CustomResourceOptions? opts = null)
    public VaultCluster(String name, VaultClusterArgs args)
public VaultCluster(String name, VaultClusterArgs args, CustomResourceOptions options)

    type: hcp:VaultCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VaultClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VaultClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VaultClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VaultClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VaultClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vaultClusterResource = new Hcp.VaultCluster("vaultClusterResource", new()
{
    ClusterId = "string",
    HvnId = "string",
    AuditLogConfig = new Hcp.Inputs.VaultClusterAuditLogConfigArgs
    {
        DatadogApiKey = "string",
        DatadogRegion = "string",
        GrafanaEndpoint = "string",
        GrafanaPassword = "string",
        GrafanaUser = "string",
        SplunkHecendpoint = "string",
        SplunkToken = "string",
    },
    MajorVersionUpgradeConfig = new Hcp.Inputs.VaultClusterMajorVersionUpgradeConfigArgs
    {
        UpgradeType = "string",
        MaintenanceWindowDay = "string",
        MaintenanceWindowTime = "string",
    },
    MetricsConfig = new Hcp.Inputs.VaultClusterMetricsConfigArgs
    {
        DatadogApiKey = "string",
        DatadogRegion = "string",
        GrafanaEndpoint = "string",
        GrafanaPassword = "string",
        GrafanaUser = "string",
        SplunkHecendpoint = "string",
        SplunkToken = "string",
    },
    MinVaultVersion = "string",
    PathsFilters = new[]
    {
        "string",
    },
    PrimaryLink = "string",
    PublicEndpoint = false,
    Tier = "string",
});

    example, err := hcp.NewVaultCluster(ctx, "vaultClusterResource", &hcp.VaultClusterArgs{
	ClusterId: pulumi.String("string"),
	HvnId:     pulumi.String("string"),
	AuditLogConfig: &hcp.VaultClusterAuditLogConfigArgs{
		DatadogApiKey:     pulumi.String("string"),
		DatadogRegion:     pulumi.String("string"),
		GrafanaEndpoint:   pulumi.String("string"),
		GrafanaPassword:   pulumi.String("string"),
		GrafanaUser:       pulumi.String("string"),
		SplunkHecendpoint: pulumi.String("string"),
		SplunkToken:       pulumi.String("string"),
	},
	MajorVersionUpgradeConfig: &hcp.VaultClusterMajorVersionUpgradeConfigArgs{
		UpgradeType:           pulumi.String("string"),
		MaintenanceWindowDay:  pulumi.String("string"),
		MaintenanceWindowTime: pulumi.String("string"),
	},
	MetricsConfig: &hcp.VaultClusterMetricsConfigArgs{
		DatadogApiKey:     pulumi.String("string"),
		DatadogRegion:     pulumi.String("string"),
		GrafanaEndpoint:   pulumi.String("string"),
		GrafanaPassword:   pulumi.String("string"),
		GrafanaUser:       pulumi.String("string"),
		SplunkHecendpoint: pulumi.String("string"),
		SplunkToken:       pulumi.String("string"),
	},
	MinVaultVersion: pulumi.String("string"),
	PathsFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrimaryLink:    pulumi.String("string"),
	PublicEndpoint: pulumi.Bool(false),
	Tier:           pulumi.String("string"),
})

    var vaultClusterResource = new VaultCluster("vaultClusterResource", VaultClusterArgs.builder()
    .clusterId("string")
    .hvnId("string")
    .auditLogConfig(VaultClusterAuditLogConfigArgs.builder()
        .datadogApiKey("string")
        .datadogRegion("string")
        .grafanaEndpoint("string")
        .grafanaPassword("string")
        .grafanaUser("string")
        .splunkHecendpoint("string")
        .splunkToken("string")
        .build())
    .majorVersionUpgradeConfig(VaultClusterMajorVersionUpgradeConfigArgs.builder()
        .upgradeType("string")
        .maintenanceWindowDay("string")
        .maintenanceWindowTime("string")
        .build())
    .metricsConfig(VaultClusterMetricsConfigArgs.builder()
        .datadogApiKey("string")
        .datadogRegion("string")
        .grafanaEndpoint("string")
        .grafanaPassword("string")
        .grafanaUser("string")
        .splunkHecendpoint("string")
        .splunkToken("string")
        .build())
    .minVaultVersion("string")
    .pathsFilters("string")
    .primaryLink("string")
    .publicEndpoint(false)
    .tier("string")
    .build());

    vault_cluster_resource = hcp.VaultCluster("vaultClusterResource",
    cluster_id="string",
    hvn_id="string",
    audit_log_config={
        "datadog_api_key": "string",
        "datadog_region": "string",
        "grafana_endpoint": "string",
        "grafana_password": "string",
        "grafana_user": "string",
        "splunk_hecendpoint": "string",
        "splunk_token": "string",
    },
    major_version_upgrade_config={
        "upgrade_type": "string",
        "maintenance_window_day": "string",
        "maintenance_window_time": "string",
    },
    metrics_config={
        "datadog_api_key": "string",
        "datadog_region": "string",
        "grafana_endpoint": "string",
        "grafana_password": "string",
        "grafana_user": "string",
        "splunk_hecendpoint": "string",
        "splunk_token": "string",
    },
    min_vault_version="string",
    paths_filters=["string"],
    primary_link="string",
    public_endpoint=False,
    tier="string")

    const vaultClusterResource = new hcp.VaultCluster("vaultClusterResource", {
    clusterId: "string",
    hvnId: "string",
    auditLogConfig: {
        datadogApiKey: "string",
        datadogRegion: "string",
        grafanaEndpoint: "string",
        grafanaPassword: "string",
        grafanaUser: "string",
        splunkHecendpoint: "string",
        splunkToken: "string",
    },
    majorVersionUpgradeConfig: {
        upgradeType: "string",
        maintenanceWindowDay: "string",
        maintenanceWindowTime: "string",
    },
    metricsConfig: {
        datadogApiKey: "string",
        datadogRegion: "string",
        grafanaEndpoint: "string",
        grafanaPassword: "string",
        grafanaUser: "string",
        splunkHecendpoint: "string",
        splunkToken: "string",
    },
    minVaultVersion: "string",
    pathsFilters: ["string"],
    primaryLink: "string",
    publicEndpoint: false,
    tier: "string",
});

    type: hcp:VaultCluster
properties:
    auditLogConfig:
        datadogApiKey: string
        datadogRegion: string
        grafanaEndpoint: string
        grafanaPassword: string
        grafanaUser: string
        splunkHecendpoint: string
        splunkToken: string
    clusterId: string
    hvnId: string
    majorVersionUpgradeConfig:
        maintenanceWindowDay: string
        maintenanceWindowTime: string
        upgradeType: string
    metricsConfig:
        datadogApiKey: string
        datadogRegion: string
        grafanaEndpoint: string
        grafanaPassword: string
        grafanaUser: string
        splunkHecendpoint: string
        splunkToken: string
    minVaultVersion: string
    pathsFilters:
        - string
    primaryLink: string
    publicEndpoint: false
    tier: string

    VaultCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VaultCluster resource accepts the following input properties:

    ClusterId string
    The ID of the HCP Vault cluster.
    HvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    AuditLogConfig VaultClusterAuditLogConfig
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MajorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    MetricsConfig VaultClusterMetricsConfig
    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.
    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.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    Tier string
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    ClusterId string
    The ID of the HCP Vault cluster.
    HvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    AuditLogConfig VaultClusterAuditLogConfigArgs
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    MajorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfigArgs
    The Major Version Upgrade configuration.
    MetricsConfig VaultClusterMetricsConfigArgs
    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.
    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.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    Tier string
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    clusterId String
    The ID of the HCP Vault cluster.
    hvnId String
    The ID of the HVN this HCP Vault cluster is associated to.
    auditLogConfig VaultClusterAuditLogConfig
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    majorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    metricsConfig VaultClusterMetricsConfig
    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.
    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.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    tier String
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    clusterId string
    The ID of the HCP Vault cluster.
    hvnId string
    The ID of the HVN this HCP Vault cluster is associated to.
    auditLogConfig VaultClusterAuditLogConfig
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    majorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    metricsConfig VaultClusterMetricsConfig
    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.
    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.
    publicEndpoint boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    tier string
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    cluster_id str
    The ID of the HCP Vault cluster.
    hvn_id str
    The ID of the HVN this HCP Vault cluster is associated to.
    audit_log_config VaultClusterAuditLogConfigArgs
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    major_version_upgrade_config VaultClusterMajorVersionUpgradeConfigArgs
    The Major Version Upgrade configuration.
    metrics_config VaultClusterMetricsConfigArgs
    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.
    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.
    public_endpoint bool
    Denotes that the cluster has a public endpoint. Defaults to false.
    tier str
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    clusterId String
    The ID of the HCP Vault cluster.
    hvnId String
    The ID of the HVN this HCP Vault cluster is associated to.
    auditLogConfig Property Map
    The audit logs configuration for export. (https://learn.hashicorp.com/tutorials/cloud/vault-metrics-guide#metrics-streaming-configuration)
    majorVersionUpgradeConfig Property Map
    The Major Version Upgrade configuration.
    metricsConfig 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.
    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.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint. Defaults to false.
    tier String
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VaultCluster resource produces the following output properties:

    CloudProvider string
    The provider where the HCP Vault cluster is located.
    CreatedAt string
    The time that the Vault cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    ProjectId string
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.
    CloudProvider string
    The provider where the HCP Vault cluster is located.
    CreatedAt string
    The time that the Vault cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    ProjectId string
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.
    cloudProvider String
    The provider where the HCP Vault cluster is located.
    createdAt String
    The time that the Vault cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    projectId String
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.
    cloudProvider string
    The provider where the HCP Vault cluster is located.
    createdAt string
    The time that the Vault cluster was created.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    projectId string
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.
    cloud_provider str
    The provider where the HCP Vault cluster is located.
    created_at str
    The time that the Vault cluster was created.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    project_id str
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.
    cloudProvider String
    The provider where the HCP Vault cluster is located.
    createdAt String
    The time that the Vault cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    projectId String
    The ID of the project this HCP Vault cluster is located in.
    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.
    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.

    Look up Existing VaultCluster Resource

    Get an existing VaultCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VaultClusterState, opts?: CustomResourceOptions): VaultCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_log_config: Optional[VaultClusterAuditLogConfigArgs] = None,
        cloud_provider: Optional[str] = None,
        cluster_id: Optional[str] = None,
        created_at: Optional[str] = None,
        hvn_id: Optional[str] = None,
        major_version_upgrade_config: Optional[VaultClusterMajorVersionUpgradeConfigArgs] = None,
        metrics_config: Optional[VaultClusterMetricsConfigArgs] = None,
        min_vault_version: Optional[str] = None,
        namespace: Optional[str] = None,
        organization_id: Optional[str] = None,
        paths_filters: Optional[Sequence[str]] = None,
        primary_link: Optional[str] = None,
        project_id: Optional[str] = None,
        public_endpoint: Optional[bool] = None,
        region: Optional[str] = None,
        self_link: Optional[str] = None,
        state: Optional[str] = None,
        tier: Optional[str] = None,
        vault_private_endpoint_url: Optional[str] = None,
        vault_public_endpoint_url: Optional[str] = None,
        vault_version: Optional[str] = None) -> VaultCluster
    func GetVaultCluster(ctx *Context, name string, id IDInput, state *VaultClusterState, opts ...ResourceOption) (*VaultCluster, error)
    public static VaultCluster Get(string name, Input<string> id, VaultClusterState? state, CustomResourceOptions? opts = null)
    public static VaultCluster get(String name, Output<String> id, VaultClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuditLogConfig VaultClusterAuditLogConfig
    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.
    MajorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    MetricsConfig VaultClusterMetricsConfig
    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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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.
    AuditLogConfig VaultClusterAuditLogConfigArgs
    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.
    MajorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfigArgs
    The Major Version Upgrade configuration.
    MetricsConfig VaultClusterMetricsConfigArgs
    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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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.
    auditLogConfig VaultClusterAuditLogConfig
    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.
    majorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    metricsConfig VaultClusterMetricsConfig
    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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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.
    auditLogConfig VaultClusterAuditLogConfig
    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.
    majorVersionUpgradeConfig VaultClusterMajorVersionUpgradeConfig
    The Major Version Upgrade configuration.
    metricsConfig VaultClusterMetricsConfig
    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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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_config VaultClusterAuditLogConfigArgs
    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.
    major_version_upgrade_config VaultClusterMajorVersionUpgradeConfigArgs
    The Major Version Upgrade configuration.
    metrics_config VaultClusterMetricsConfigArgs
    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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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.
    auditLogConfig 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.
    majorVersionUpgradeConfig Property Map
    The Major Version Upgrade configuration.
    metricsConfig 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
    Tier of the HCP Vault cluster. Valid options for tiers - dev, starter_small, standard_small, standard_medium, standard_large, plus_small, plus_medium, plus_large. See pricing information.
    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

    VaultClusterAuditLogConfig, VaultClusterAuditLogConfigArgs

    DatadogApiKey string
    Datadog api key for streaming audit logs
    DatadogRegion string
    Datadog region for streaming audit logs
    GrafanaEndpoint string
    Grafana endpoint for streaming audit logs
    GrafanaPassword string
    Grafana password for streaming audit logs
    GrafanaUser string
    Grafana user for streaming audit logs
    SplunkHecendpoint string
    Splunk endpoint for streaming audit logs
    SplunkToken string
    Splunk token for streaming audit logs
    DatadogApiKey string
    Datadog api key for streaming audit logs
    DatadogRegion string
    Datadog region for streaming audit logs
    GrafanaEndpoint string
    Grafana endpoint for streaming audit logs
    GrafanaPassword string
    Grafana password for streaming audit logs
    GrafanaUser string
    Grafana user for streaming audit logs
    SplunkHecendpoint string
    Splunk endpoint for streaming audit logs
    SplunkToken string
    Splunk token for streaming audit logs
    datadogApiKey String
    Datadog api key for streaming audit logs
    datadogRegion String
    Datadog region for streaming audit logs
    grafanaEndpoint String
    Grafana endpoint for streaming audit logs
    grafanaPassword String
    Grafana password for streaming audit logs
    grafanaUser String
    Grafana user for streaming audit logs
    splunkHecendpoint String
    Splunk endpoint for streaming audit logs
    splunkToken String
    Splunk token for streaming audit logs
    datadogApiKey string
    Datadog api key for streaming audit logs
    datadogRegion string
    Datadog region for streaming audit logs
    grafanaEndpoint string
    Grafana endpoint for streaming audit logs
    grafanaPassword string
    Grafana password for streaming audit logs
    grafanaUser string
    Grafana user for streaming audit logs
    splunkHecendpoint string
    Splunk endpoint for streaming audit logs
    splunkToken string
    Splunk token for streaming audit logs
    datadog_api_key str
    Datadog api key for streaming audit logs
    datadog_region str
    Datadog region for streaming audit logs
    grafana_endpoint str
    Grafana endpoint for streaming audit logs
    grafana_password str
    Grafana password for streaming audit logs
    grafana_user str
    Grafana user for streaming audit logs
    splunk_hecendpoint str
    Splunk endpoint for streaming audit logs
    splunk_token str
    Splunk token for streaming audit logs
    datadogApiKey String
    Datadog api key for streaming audit logs
    datadogRegion String
    Datadog region for streaming audit logs
    grafanaEndpoint String
    Grafana endpoint for streaming audit logs
    grafanaPassword String
    Grafana password for streaming audit logs
    grafanaUser String
    Grafana user for streaming audit logs
    splunkHecendpoint String
    Splunk endpoint for streaming audit logs
    splunkToken String
    Splunk token for streaming audit logs

    VaultClusterMajorVersionUpgradeConfig, VaultClusterMajorVersionUpgradeConfigArgs

    UpgradeType string
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    MaintenanceWindowDay string
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    MaintenanceWindowTime string
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM
    UpgradeType string
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    MaintenanceWindowDay string
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    MaintenanceWindowTime string
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM
    upgradeType String
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    maintenanceWindowDay String
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    maintenanceWindowTime String
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM
    upgradeType string
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    maintenanceWindowDay string
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    maintenanceWindowTime string
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM
    upgrade_type str
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    maintenance_window_day str
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    maintenance_window_time str
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM
    upgradeType String
    The major upgrade type for the cluster. Valid options for upgrade type - AUTOMATIC, SCHEDULED, MANUAL
    maintenanceWindowDay String
    The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    maintenanceWindowTime String
    The maintenance time frame for scheduled upgrades. Valid options for maintenance window time - WINDOW_12AM_4AM, WINDOW_6AM_10AM, WINDOW_12PM_4PM, WINDOW_6PM_10PM

    VaultClusterMetricsConfig, VaultClusterMetricsConfigArgs

    DatadogApiKey string
    Datadog api key for streaming metrics
    DatadogRegion string
    Datadog region for streaming metrics
    GrafanaEndpoint string
    Grafana endpoint for streaming metrics
    GrafanaPassword string
    Grafana password for streaming metrics
    GrafanaUser string
    Grafana user for streaming metrics
    SplunkHecendpoint string
    Splunk endpoint for streaming metrics
    SplunkToken string
    Splunk token for streaming metrics
    DatadogApiKey string
    Datadog api key for streaming metrics
    DatadogRegion string
    Datadog region for streaming metrics
    GrafanaEndpoint string
    Grafana endpoint for streaming metrics
    GrafanaPassword string
    Grafana password for streaming metrics
    GrafanaUser string
    Grafana user for streaming metrics
    SplunkHecendpoint string
    Splunk endpoint for streaming metrics
    SplunkToken string
    Splunk token for streaming metrics
    datadogApiKey String
    Datadog api key for streaming metrics
    datadogRegion String
    Datadog region for streaming metrics
    grafanaEndpoint String
    Grafana endpoint for streaming metrics
    grafanaPassword String
    Grafana password for streaming metrics
    grafanaUser String
    Grafana user for streaming metrics
    splunkHecendpoint String
    Splunk endpoint for streaming metrics
    splunkToken String
    Splunk token for streaming metrics
    datadogApiKey string
    Datadog api key for streaming metrics
    datadogRegion string
    Datadog region for streaming metrics
    grafanaEndpoint string
    Grafana endpoint for streaming metrics
    grafanaPassword string
    Grafana password for streaming metrics
    grafanaUser string
    Grafana user for streaming metrics
    splunkHecendpoint string
    Splunk endpoint for streaming metrics
    splunkToken string
    Splunk token for streaming metrics
    datadog_api_key str
    Datadog api key for streaming metrics
    datadog_region str
    Datadog region for streaming metrics
    grafana_endpoint str
    Grafana endpoint for streaming metrics
    grafana_password str
    Grafana password for streaming metrics
    grafana_user str
    Grafana user for streaming metrics
    splunk_hecendpoint str
    Splunk endpoint for streaming metrics
    splunk_token str
    Splunk token for streaming metrics
    datadogApiKey String
    Datadog api key for streaming metrics
    datadogRegion String
    Datadog region for streaming metrics
    grafanaEndpoint String
    Grafana endpoint for streaming metrics
    grafanaPassword String
    Grafana password for streaming metrics
    grafanaUser String
    Grafana user for streaming metrics
    splunkHecendpoint String
    Splunk endpoint for streaming metrics
    splunkToken String
    Splunk token 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