1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getVaultConnector
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

harness.platform.getVaultConnector

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getVaultConnector({
        identifier: "identifier",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_vault_connector(identifier="identifier")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.LookupVaultConnector(ctx, &platform.LookupVaultConnectorArgs{
    			Identifier: "identifier",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetVaultConnector.Invoke(new()
        {
            Identifier = "identifier",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetVaultConnectorArgs;
    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 = PlatformFunctions.getVaultConnector(GetVaultConnectorArgs.builder()
                .identifier("identifier")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getVaultConnector
          Arguments:
            identifier: identifier
    

    Using getVaultConnector

    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 getVaultConnector(args: GetVaultConnectorArgs, opts?: InvokeOptions): Promise<GetVaultConnectorResult>
    function getVaultConnectorOutput(args: GetVaultConnectorOutputArgs, opts?: InvokeOptions): Output<GetVaultConnectorResult>
    def get_vault_connector(identifier: Optional[str] = None,
                            name: Optional[str] = None,
                            org_id: Optional[str] = None,
                            project_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVaultConnectorResult
    def get_vault_connector_output(identifier: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            org_id: Optional[pulumi.Input[str]] = None,
                            project_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetVaultConnectorResult]
    func LookupVaultConnector(ctx *Context, args *LookupVaultConnectorArgs, opts ...InvokeOption) (*LookupVaultConnectorResult, error)
    func LookupVaultConnectorOutput(ctx *Context, args *LookupVaultConnectorOutputArgs, opts ...InvokeOption) LookupVaultConnectorResultOutput

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

    public static class GetVaultConnector 
    {
        public static Task<GetVaultConnectorResult> InvokeAsync(GetVaultConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetVaultConnectorResult> Invoke(GetVaultConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVaultConnectorResult> getVaultConnector(GetVaultConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getVaultConnector:getVaultConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    getVaultConnector Result

    The following output properties are available:

    AccessType string
    Access type.
    AppRoleId string
    ID of App Role.
    AuthToken string
    The authentication token for Vault.
    AwsRegion string
    The AWS region where AWS IAM auth will happen.
    BasePath string
    The location of the Vault directory where Secret will be stored.
    Default bool
    Is default or not.
    DelegateSelectors List<string>
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    IsDefault bool
    Is default or not.
    IsReadOnly bool
    Read only or not.
    K8sAuthEndpoint string
    The path where kubernetes auth is enabled in Vault.
    Namespace string
    The Vault namespace where Secret will be created.
    ReadOnly bool
    Read only.
    RenewAppRoleToken bool
    Boolean value to indicate if appRole token renewal is enabled or not.
    RenewalIntervalMinutes int
    The time interval for token renewal.
    SecretEngineManuallyConfigured bool
    Manually entered Secret Engine.
    SecretEngineName string
    Name of the Secret Engine.
    SecretEngineVersion int
    Version of Secret Engine.
    SecretId string
    ID of the Secret.
    ServiceAccountTokenPath string
    The SA token path where the token is mounted in the K8s Pod.
    SinkPath string
    The location at which auth token is to be read from.
    Tags List<string>
    Tags to associate with the resource.
    UseAwsIam bool
    Boolean value to indicate if AWS IAM is used for authentication.
    UseK8sAuth bool
    Boolean value to indicate if K8s Auth is used for authentication.
    UseVaultAgent bool
    Boolean value to indicate if Vault Agent is used for authentication.
    VaultAwsIamRole string
    The Vault role defined to bind to AWS IAM account/role being accessed.
    VaultK8sAuthRole string
    The role where K8s auth will happen.
    VaultUrl string
    URL of the HashiCorp Vault.
    XvaultAwsIamServerId string
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    AccessType string
    Access type.
    AppRoleId string
    ID of App Role.
    AuthToken string
    The authentication token for Vault.
    AwsRegion string
    The AWS region where AWS IAM auth will happen.
    BasePath string
    The location of the Vault directory where Secret will be stored.
    Default bool
    Is default or not.
    DelegateSelectors []string
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    IsDefault bool
    Is default or not.
    IsReadOnly bool
    Read only or not.
    K8sAuthEndpoint string
    The path where kubernetes auth is enabled in Vault.
    Namespace string
    The Vault namespace where Secret will be created.
    ReadOnly bool
    Read only.
    RenewAppRoleToken bool
    Boolean value to indicate if appRole token renewal is enabled or not.
    RenewalIntervalMinutes int
    The time interval for token renewal.
    SecretEngineManuallyConfigured bool
    Manually entered Secret Engine.
    SecretEngineName string
    Name of the Secret Engine.
    SecretEngineVersion int
    Version of Secret Engine.
    SecretId string
    ID of the Secret.
    ServiceAccountTokenPath string
    The SA token path where the token is mounted in the K8s Pod.
    SinkPath string
    The location at which auth token is to be read from.
    Tags []string
    Tags to associate with the resource.
    UseAwsIam bool
    Boolean value to indicate if AWS IAM is used for authentication.
    UseK8sAuth bool
    Boolean value to indicate if K8s Auth is used for authentication.
    UseVaultAgent bool
    Boolean value to indicate if Vault Agent is used for authentication.
    VaultAwsIamRole string
    The Vault role defined to bind to AWS IAM account/role being accessed.
    VaultK8sAuthRole string
    The role where K8s auth will happen.
    VaultUrl string
    URL of the HashiCorp Vault.
    XvaultAwsIamServerId string
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    accessType String
    Access type.
    appRoleId String
    ID of App Role.
    authToken String
    The authentication token for Vault.
    awsRegion String
    The AWS region where AWS IAM auth will happen.
    basePath String
    The location of the Vault directory where Secret will be stored.
    default_ Boolean
    Is default or not.
    delegateSelectors List<String>
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    isDefault Boolean
    Is default or not.
    isReadOnly Boolean
    Read only or not.
    k8sAuthEndpoint String
    The path where kubernetes auth is enabled in Vault.
    namespace String
    The Vault namespace where Secret will be created.
    readOnly Boolean
    Read only.
    renewAppRoleToken Boolean
    Boolean value to indicate if appRole token renewal is enabled or not.
    renewalIntervalMinutes Integer
    The time interval for token renewal.
    secretEngineManuallyConfigured Boolean
    Manually entered Secret Engine.
    secretEngineName String
    Name of the Secret Engine.
    secretEngineVersion Integer
    Version of Secret Engine.
    secretId String
    ID of the Secret.
    serviceAccountTokenPath String
    The SA token path where the token is mounted in the K8s Pod.
    sinkPath String
    The location at which auth token is to be read from.
    tags List<String>
    Tags to associate with the resource.
    useAwsIam Boolean
    Boolean value to indicate if AWS IAM is used for authentication.
    useK8sAuth Boolean
    Boolean value to indicate if K8s Auth is used for authentication.
    useVaultAgent Boolean
    Boolean value to indicate if Vault Agent is used for authentication.
    vaultAwsIamRole String
    The Vault role defined to bind to AWS IAM account/role being accessed.
    vaultK8sAuthRole String
    The role where K8s auth will happen.
    vaultUrl String
    URL of the HashiCorp Vault.
    xvaultAwsIamServerId String
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    accessType string
    Access type.
    appRoleId string
    ID of App Role.
    authToken string
    The authentication token for Vault.
    awsRegion string
    The AWS region where AWS IAM auth will happen.
    basePath string
    The location of the Vault directory where Secret will be stored.
    default boolean
    Is default or not.
    delegateSelectors string[]
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    description string
    Description of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    isDefault boolean
    Is default or not.
    isReadOnly boolean
    Read only or not.
    k8sAuthEndpoint string
    The path where kubernetes auth is enabled in Vault.
    namespace string
    The Vault namespace where Secret will be created.
    readOnly boolean
    Read only.
    renewAppRoleToken boolean
    Boolean value to indicate if appRole token renewal is enabled or not.
    renewalIntervalMinutes number
    The time interval for token renewal.
    secretEngineManuallyConfigured boolean
    Manually entered Secret Engine.
    secretEngineName string
    Name of the Secret Engine.
    secretEngineVersion number
    Version of Secret Engine.
    secretId string
    ID of the Secret.
    serviceAccountTokenPath string
    The SA token path where the token is mounted in the K8s Pod.
    sinkPath string
    The location at which auth token is to be read from.
    tags string[]
    Tags to associate with the resource.
    useAwsIam boolean
    Boolean value to indicate if AWS IAM is used for authentication.
    useK8sAuth boolean
    Boolean value to indicate if K8s Auth is used for authentication.
    useVaultAgent boolean
    Boolean value to indicate if Vault Agent is used for authentication.
    vaultAwsIamRole string
    The Vault role defined to bind to AWS IAM account/role being accessed.
    vaultK8sAuthRole string
    The role where K8s auth will happen.
    vaultUrl string
    URL of the HashiCorp Vault.
    xvaultAwsIamServerId string
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    access_type str
    Access type.
    app_role_id str
    ID of App Role.
    auth_token str
    The authentication token for Vault.
    aws_region str
    The AWS region where AWS IAM auth will happen.
    base_path str
    The location of the Vault directory where Secret will be stored.
    default bool
    Is default or not.
    delegate_selectors Sequence[str]
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    description str
    Description of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    is_default bool
    Is default or not.
    is_read_only bool
    Read only or not.
    k8s_auth_endpoint str
    The path where kubernetes auth is enabled in Vault.
    namespace str
    The Vault namespace where Secret will be created.
    read_only bool
    Read only.
    renew_app_role_token bool
    Boolean value to indicate if appRole token renewal is enabled or not.
    renewal_interval_minutes int
    The time interval for token renewal.
    secret_engine_manually_configured bool
    Manually entered Secret Engine.
    secret_engine_name str
    Name of the Secret Engine.
    secret_engine_version int
    Version of Secret Engine.
    secret_id str
    ID of the Secret.
    service_account_token_path str
    The SA token path where the token is mounted in the K8s Pod.
    sink_path str
    The location at which auth token is to be read from.
    tags Sequence[str]
    Tags to associate with the resource.
    use_aws_iam bool
    Boolean value to indicate if AWS IAM is used for authentication.
    use_k8s_auth bool
    Boolean value to indicate if K8s Auth is used for authentication.
    use_vault_agent bool
    Boolean value to indicate if Vault Agent is used for authentication.
    vault_aws_iam_role str
    The Vault role defined to bind to AWS IAM account/role being accessed.
    vault_k8s_auth_role str
    The role where K8s auth will happen.
    vault_url str
    URL of the HashiCorp Vault.
    xvault_aws_iam_server_id str
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    accessType String
    Access type.
    appRoleId String
    ID of App Role.
    authToken String
    The authentication token for Vault.
    awsRegion String
    The AWS region where AWS IAM auth will happen.
    basePath String
    The location of the Vault directory where Secret will be stored.
    default Boolean
    Is default or not.
    delegateSelectors List<String>
    List of Delegate Selectors that belong to the same Delegate and are used to connect to the Secret Manager.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    isDefault Boolean
    Is default or not.
    isReadOnly Boolean
    Read only or not.
    k8sAuthEndpoint String
    The path where kubernetes auth is enabled in Vault.
    namespace String
    The Vault namespace where Secret will be created.
    readOnly Boolean
    Read only.
    renewAppRoleToken Boolean
    Boolean value to indicate if appRole token renewal is enabled or not.
    renewalIntervalMinutes Number
    The time interval for token renewal.
    secretEngineManuallyConfigured Boolean
    Manually entered Secret Engine.
    secretEngineName String
    Name of the Secret Engine.
    secretEngineVersion Number
    Version of Secret Engine.
    secretId String
    ID of the Secret.
    serviceAccountTokenPath String
    The SA token path where the token is mounted in the K8s Pod.
    sinkPath String
    The location at which auth token is to be read from.
    tags List<String>
    Tags to associate with the resource.
    useAwsIam Boolean
    Boolean value to indicate if AWS IAM is used for authentication.
    useK8sAuth Boolean
    Boolean value to indicate if K8s Auth is used for authentication.
    useVaultAgent Boolean
    Boolean value to indicate if Vault Agent is used for authentication.
    vaultAwsIamRole String
    The Vault role defined to bind to AWS IAM account/role being accessed.
    vaultK8sAuthRole String
    The role where K8s auth will happen.
    vaultUrl String
    URL of the HashiCorp Vault.
    xvaultAwsIamServerId String
    The AWS IAM Header Server ID that has been configured for this AWS IAM instance.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi