1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. GcpSecretManagerConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.GcpSecretManagerConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating a GCP Secret Manager connector.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var gcpSm = new Harness.Platform.GcpSecretManagerConnector("gcpSm", new()
        {
            CredentialsRef = $"account.{harness_platform_secret_text.Test.Id}",
            DelegateSelectors = new[]
            {
                "harness-delegate",
            },
            Description = "test",
            Identifier = "identifier",
            Tags = new[]
            {
                "foo:bar",
            },
        });
    
    });
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/lbrlabs/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.NewGcpSecretManagerConnector(ctx, "gcpSm", &platform.GcpSecretManagerConnectorArgs{
    			CredentialsRef: pulumi.String(fmt.Sprintf("account.%v", harness_platform_secret_text.Test.Id)),
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("harness-delegate"),
    			},
    			Description: pulumi.String("test"),
    			Identifier:  pulumi.String("identifier"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    		})
    		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.harness.platform.GcpSecretManagerConnector;
    import com.pulumi.harness.platform.GcpSecretManagerConnectorArgs;
    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) {
            var gcpSm = new GcpSecretManagerConnector("gcpSm", GcpSecretManagerConnectorArgs.builder()        
                .credentialsRef(String.format("account.%s", harness_platform_secret_text.test().id()))
                .delegateSelectors("harness-delegate")
                .description("test")
                .identifier("identifier")
                .tags("foo:bar")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    gcp_sm = harness.platform.GcpSecretManagerConnector("gcpSm",
        credentials_ref=f"account.{harness_platform_secret_text['test']['id']}",
        delegate_selectors=["harness-delegate"],
        description="test",
        identifier="identifier",
        tags=["foo:bar"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const gcpSm = new harness.platform.GcpSecretManagerConnector("gcpSm", {
        credentialsRef: `account.${harness_platform_secret_text.test.id}`,
        delegateSelectors: ["harness-delegate"],
        description: "test",
        identifier: "identifier",
        tags: ["foo:bar"],
    });
    
    resources:
      gcpSm:
        type: harness:platform:GcpSecretManagerConnector
        properties:
          credentialsRef: account.${harness_platform_secret_text.test.id}
          delegateSelectors:
            - harness-delegate
          description: test
          identifier: identifier
          tags:
            - foo:bar
    

    Create GcpSecretManagerConnector Resource

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

    Constructor syntax

    new GcpSecretManagerConnector(name: string, args: GcpSecretManagerConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def GcpSecretManagerConnector(resource_name: str,
                                  args: GcpSecretManagerConnectorArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def GcpSecretManagerConnector(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  credentials_ref: Optional[str] = None,
                                  identifier: Optional[str] = None,
                                  delegate_selectors: Optional[Sequence[str]] = None,
                                  description: Optional[str] = None,
                                  is_default: Optional[bool] = None,
                                  name: Optional[str] = None,
                                  org_id: Optional[str] = None,
                                  project_id: Optional[str] = None,
                                  tags: Optional[Sequence[str]] = None)
    func NewGcpSecretManagerConnector(ctx *Context, name string, args GcpSecretManagerConnectorArgs, opts ...ResourceOption) (*GcpSecretManagerConnector, error)
    public GcpSecretManagerConnector(string name, GcpSecretManagerConnectorArgs args, CustomResourceOptions? opts = null)
    public GcpSecretManagerConnector(String name, GcpSecretManagerConnectorArgs args)
    public GcpSecretManagerConnector(String name, GcpSecretManagerConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:GcpSecretManagerConnector
    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 GcpSecretManagerConnectorArgs
    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 GcpSecretManagerConnectorArgs
    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 GcpSecretManagerConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GcpSecretManagerConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GcpSecretManagerConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var gcpSecretManagerConnectorResource = new Harness.Platform.GcpSecretManagerConnector("gcpSecretManagerConnectorResource", new()
    {
        CredentialsRef = "string",
        Identifier = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        IsDefault = false,
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewGcpSecretManagerConnector(ctx, "gcpSecretManagerConnectorResource", &platform.GcpSecretManagerConnectorArgs{
    	CredentialsRef: pulumi.String("string"),
    	Identifier:     pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	IsDefault:   pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var gcpSecretManagerConnectorResource = new GcpSecretManagerConnector("gcpSecretManagerConnectorResource", GcpSecretManagerConnectorArgs.builder()
        .credentialsRef("string")
        .identifier("string")
        .delegateSelectors("string")
        .description("string")
        .isDefault(false)
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    gcp_secret_manager_connector_resource = harness.platform.GcpSecretManagerConnector("gcpSecretManagerConnectorResource",
        credentials_ref="string",
        identifier="string",
        delegate_selectors=["string"],
        description="string",
        is_default=False,
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const gcpSecretManagerConnectorResource = new harness.platform.GcpSecretManagerConnector("gcpSecretManagerConnectorResource", {
        credentialsRef: "string",
        identifier: "string",
        delegateSelectors: ["string"],
        description: "string",
        isDefault: false,
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:GcpSecretManagerConnector
    properties:
        credentialsRef: string
        delegateSelectors:
            - string
        description: string
        identifier: string
        isDefault: false
        name: string
        orgId: string
        projectId: string
        tags:
            - string
    

    GcpSecretManagerConnector Resource Properties

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

    Inputs

    The GcpSecretManagerConnector resource accepts the following input properties:

    CredentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    IsDefault bool
    Indicative if this is default Secret manager for secrets.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    CredentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Identifier string
    Unique identifier of the resource.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    IsDefault bool
    Indicative if this is default Secret manager for secrets.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    credentialsRef String
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    isDefault Boolean
    Indicative if this is default Secret manager for secrets.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    credentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier string
    Unique identifier of the resource.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    isDefault boolean
    Indicative if this is default Secret manager for secrets.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    credentials_ref str
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier str
    Unique identifier of the resource.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    is_default bool
    Indicative if this is default Secret manager for secrets.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    credentialsRef String
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    identifier String
    Unique identifier of the resource.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    isDefault Boolean
    Indicative if this is default Secret manager for secrets.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GcpSecretManagerConnector Resource

    Get an existing GcpSecretManagerConnector 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?: GcpSecretManagerConnectorState, opts?: CustomResourceOptions): GcpSecretManagerConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials_ref: Optional[str] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            is_default: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> GcpSecretManagerConnector
    func GetGcpSecretManagerConnector(ctx *Context, name string, id IDInput, state *GcpSecretManagerConnectorState, opts ...ResourceOption) (*GcpSecretManagerConnector, error)
    public static GcpSecretManagerConnector Get(string name, Input<string> id, GcpSecretManagerConnectorState? state, CustomResourceOptions? opts = null)
    public static GcpSecretManagerConnector get(String name, Output<String> id, GcpSecretManagerConnectorState 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:
    CredentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    IsDefault bool
    Indicative if this is default Secret manager for secrets.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    CredentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    IsDefault bool
    Indicative if this is default Secret manager for secrets.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    credentialsRef String
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    isDefault Boolean
    Indicative if this is default Secret manager for secrets.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    credentialsRef string
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    isDefault boolean
    Indicative if this is default Secret manager for secrets.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    credentials_ref str
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    identifier str
    Unique identifier of the resource.
    is_default bool
    Indicative if this is default Secret manager for secrets.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    credentialsRef String
    Reference to the secret containing credentials of IAM service account for Google Secret Manager. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    isDefault Boolean
    Indicative if this is default Secret manager for secrets.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Import

    Import account level gcp secret manager connector

     $ pulumi import harness:platform/gcpSecretManagerConnector:GcpSecretManagerConnector example <connector_id>
    

    Import org level gcp secret manager connector

     $ pulumi import harness:platform/gcpSecretManagerConnector:GcpSecretManagerConnector example <ord_id>/<connector_id>
    

    Import project level gcp secret manager connector

     $ pulumi import harness:platform/gcpSecretManagerConnector:GcpSecretManagerConnector example <org_id>/<project_id>/<connector_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs