Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. GcpConnector
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.GcpConnector

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating a Gcp connector.

    Create GcpConnector Resource

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

    Constructor syntax

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

@overload
def GcpConnector(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 identifier: Optional[str] = None,
                 description: Optional[str] = None,
                 execute_on_delegate: Optional[bool] = None,
                 force_delete: Optional[bool] = None,
                 inherit_from_delegates: Optional[Sequence[GcpConnectorInheritFromDelegateArgs]] = None,
                 manual: Optional[GcpConnectorManualArgs] = None,
                 name: Optional[str] = None,
                 oidc_authentications: Optional[Sequence[GcpConnectorOidcAuthenticationArgs]] = None,
                 org_id: Optional[str] = None,
                 project_id: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None)
    func NewGcpConnector(ctx *Context, name string, args GcpConnectorArgs, opts ...ResourceOption) (*GcpConnector, error)
    public GcpConnector(string name, GcpConnectorArgs args, CustomResourceOptions? opts = null)
    public GcpConnector(String name, GcpConnectorArgs args)
public GcpConnector(String name, GcpConnectorArgs args, CustomResourceOptions options)

    type: harness:platform:GcpConnector
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 GcpConnectorArgs
    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 GcpConnectorArgs
    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 GcpConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GcpConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GcpConnectorArgs
    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 gcpConnectorResource = new Harness.Platform.GcpConnector("gcpConnectorResource", new()
{
    Identifier = "string",
    Description = "string",
    ExecuteOnDelegate = false,
    ForceDelete = false,
    InheritFromDelegates = new[]
    {
        new Harness.Platform.Inputs.GcpConnectorInheritFromDelegateArgs
        {
            DelegateSelectors = new[]
            {
                "string",
            },
        },
    },
    Manual = new Harness.Platform.Inputs.GcpConnectorManualArgs
    {
        SecretKeyRef = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
    },
    Name = "string",
    OidcAuthentications = new[]
    {
        new Harness.Platform.Inputs.GcpConnectorOidcAuthenticationArgs
        {
            DelegateSelectors = new[]
            {
                "string",
            },
            GcpProjectId = "string",
            ProviderId = "string",
            ServiceAccountEmail = "string",
            WorkloadPoolId = "string",
        },
    },
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := platform.NewGcpConnector(ctx, "gcpConnectorResource", &platform.GcpConnectorArgs{
	Identifier:        pulumi.String("string"),
	Description:       pulumi.String("string"),
	ExecuteOnDelegate: pulumi.Bool(false),
	ForceDelete:       pulumi.Bool(false),
	InheritFromDelegates: platform.GcpConnectorInheritFromDelegateArray{
		&platform.GcpConnectorInheritFromDelegateArgs{
			DelegateSelectors: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Manual: &platform.GcpConnectorManualArgs{
		SecretKeyRef: pulumi.String("string"),
		DelegateSelectors: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	OidcAuthentications: platform.GcpConnectorOidcAuthenticationArray{
		&platform.GcpConnectorOidcAuthenticationArgs{
			DelegateSelectors: pulumi.StringArray{
				pulumi.String("string"),
			},
			GcpProjectId:        pulumi.String("string"),
			ProviderId:          pulumi.String("string"),
			ServiceAccountEmail: pulumi.String("string"),
			WorkloadPoolId:      pulumi.String("string"),
		},
	},
	OrgId:     pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var gcpConnectorResource = new GcpConnector("gcpConnectorResource", GcpConnectorArgs.builder()
    .identifier("string")
    .description("string")
    .executeOnDelegate(false)
    .forceDelete(false)
    .inheritFromDelegates(GcpConnectorInheritFromDelegateArgs.builder()
        .delegateSelectors("string")
        .build())
    .manual(GcpConnectorManualArgs.builder()
        .secretKeyRef("string")
        .delegateSelectors("string")
        .build())
    .name("string")
    .oidcAuthentications(GcpConnectorOidcAuthenticationArgs.builder()
        .delegateSelectors("string")
        .gcpProjectId("string")
        .providerId("string")
        .serviceAccountEmail("string")
        .workloadPoolId("string")
        .build())
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());

    gcp_connector_resource = harness.platform.GcpConnector("gcpConnectorResource",
    identifier="string",
    description="string",
    execute_on_delegate=False,
    force_delete=False,
    inherit_from_delegates=[{
        "delegate_selectors": ["string"],
    }],
    manual={
        "secret_key_ref": "string",
        "delegate_selectors": ["string"],
    },
    name="string",
    oidc_authentications=[{
        "delegate_selectors": ["string"],
        "gcp_project_id": "string",
        "provider_id": "string",
        "service_account_email": "string",
        "workload_pool_id": "string",
    }],
    org_id="string",
    project_id="string",
    tags=["string"])

    const gcpConnectorResource = new harness.platform.GcpConnector("gcpConnectorResource", {
    identifier: "string",
    description: "string",
    executeOnDelegate: false,
    forceDelete: false,
    inheritFromDelegates: [{
        delegateSelectors: ["string"],
    }],
    manual: {
        secretKeyRef: "string",
        delegateSelectors: ["string"],
    },
    name: "string",
    oidcAuthentications: [{
        delegateSelectors: ["string"],
        gcpProjectId: "string",
        providerId: "string",
        serviceAccountEmail: "string",
        workloadPoolId: "string",
    }],
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});

    type: harness:platform:GcpConnector
properties:
    description: string
    executeOnDelegate: false
    forceDelete: false
    identifier: string
    inheritFromDelegates:
        - delegateSelectors:
            - string
    manual:
        delegateSelectors:
            - string
        secretKeyRef: string
    name: string
    oidcAuthentications:
        - delegateSelectors:
            - string
          gcpProjectId: string
          providerId: string
          serviceAccountEmail: string
          workloadPoolId: string
    orgId: string
    projectId: string
    tags:
        - string

    GcpConnector 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 GcpConnector resource accepts the following input properties:

    Identifier string
    Unique identifier of the resource.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Enable this flag to execute on Delegate
    ForceDelete bool
    Enable this flag for force deletion of connector
    InheritFromDelegates List<GcpConnectorInheritFromDelegate>
    Inherit configuration from delegate.
    Manual GcpConnectorManual
    Manual credential configuration.
    Name string
    Name of the resource.
    OidcAuthentications List<GcpConnectorOidcAuthentication>
    Authentication using harness oidc.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Identifier string
    Unique identifier of the resource.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Enable this flag to execute on Delegate
    ForceDelete bool
    Enable this flag for force deletion of connector
    InheritFromDelegates []GcpConnectorInheritFromDelegateArgs
    Inherit configuration from delegate.
    Manual GcpConnectorManualArgs
    Manual credential configuration.
    Name string
    Name of the resource.
    OidcAuthentications []GcpConnectorOidcAuthenticationArgs
    Authentication using harness oidc.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Enable this flag to execute on Delegate
    forceDelete Boolean
    Enable this flag for force deletion of connector
    inheritFromDelegates List<GcpConnectorInheritFromDelegate>
    Inherit configuration from delegate.
    manual GcpConnectorManual
    Manual credential configuration.
    name String
    Name of the resource.
    oidcAuthentications List<GcpConnectorOidcAuthentication>
    Authentication using harness oidc.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    identifier string
    Unique identifier of the resource.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Enable this flag to execute on Delegate
    forceDelete boolean
    Enable this flag for force deletion of connector
    inheritFromDelegates GcpConnectorInheritFromDelegate[]
    Inherit configuration from delegate.
    manual GcpConnectorManual
    Manual credential configuration.
    name string
    Name of the resource.
    oidcAuthentications GcpConnectorOidcAuthentication[]
    Authentication using harness oidc.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    identifier str
    Unique identifier of the resource.
    description str
    Description of the resource.
    execute_on_delegate bool
    Enable this flag to execute on Delegate
    force_delete bool
    Enable this flag for force deletion of connector
    inherit_from_delegates Sequence[GcpConnectorInheritFromDelegateArgs]
    Inherit configuration from delegate.
    manual GcpConnectorManualArgs
    Manual credential configuration.
    name str
    Name of the resource.
    oidc_authentications Sequence[GcpConnectorOidcAuthenticationArgs]
    Authentication using harness oidc.
    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.
    identifier String
    Unique identifier of the resource.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Enable this flag to execute on Delegate
    forceDelete Boolean
    Enable this flag for force deletion of connector
    inheritFromDelegates List<Property Map>
    Inherit configuration from delegate.
    manual Property Map
    Manual credential configuration.
    name String
    Name of the resource.
    oidcAuthentications List<Property Map>
    Authentication using harness oidc.
    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 GcpConnector 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 GcpConnector Resource

    Get an existing GcpConnector 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?: GcpConnectorState, opts?: CustomResourceOptions): GcpConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        execute_on_delegate: Optional[bool] = None,
        force_delete: Optional[bool] = None,
        identifier: Optional[str] = None,
        inherit_from_delegates: Optional[Sequence[GcpConnectorInheritFromDelegateArgs]] = None,
        manual: Optional[GcpConnectorManualArgs] = None,
        name: Optional[str] = None,
        oidc_authentications: Optional[Sequence[GcpConnectorOidcAuthenticationArgs]] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> GcpConnector
    func GetGcpConnector(ctx *Context, name string, id IDInput, state *GcpConnectorState, opts ...ResourceOption) (*GcpConnector, error)
    public static GcpConnector Get(string name, Input<string> id, GcpConnectorState? state, CustomResourceOptions? opts = null)
    public static GcpConnector get(String name, Output<String> id, GcpConnectorState 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:
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Enable this flag to execute on Delegate
    ForceDelete bool
    Enable this flag for force deletion of connector
    Identifier string
    Unique identifier of the resource.
    InheritFromDelegates List<GcpConnectorInheritFromDelegate>
    Inherit configuration from delegate.
    Manual GcpConnectorManual
    Manual credential configuration.
    Name string
    Name of the resource.
    OidcAuthentications List<GcpConnectorOidcAuthentication>
    Authentication using harness oidc.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Enable this flag to execute on Delegate
    ForceDelete bool
    Enable this flag for force deletion of connector
    Identifier string
    Unique identifier of the resource.
    InheritFromDelegates []GcpConnectorInheritFromDelegateArgs
    Inherit configuration from delegate.
    Manual GcpConnectorManualArgs
    Manual credential configuration.
    Name string
    Name of the resource.
    OidcAuthentications []GcpConnectorOidcAuthenticationArgs
    Authentication using harness oidc.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Enable this flag to execute on Delegate
    forceDelete Boolean
    Enable this flag for force deletion of connector
    identifier String
    Unique identifier of the resource.
    inheritFromDelegates List<GcpConnectorInheritFromDelegate>
    Inherit configuration from delegate.
    manual GcpConnectorManual
    Manual credential configuration.
    name String
    Name of the resource.
    oidcAuthentications List<GcpConnectorOidcAuthentication>
    Authentication using harness oidc.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Enable this flag to execute on Delegate
    forceDelete boolean
    Enable this flag for force deletion of connector
    identifier string
    Unique identifier of the resource.
    inheritFromDelegates GcpConnectorInheritFromDelegate[]
    Inherit configuration from delegate.
    manual GcpConnectorManual
    Manual credential configuration.
    name string
    Name of the resource.
    oidcAuthentications GcpConnectorOidcAuthentication[]
    Authentication using harness oidc.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    description str
    Description of the resource.
    execute_on_delegate bool
    Enable this flag to execute on Delegate
    force_delete bool
    Enable this flag for force deletion of connector
    identifier str
    Unique identifier of the resource.
    inherit_from_delegates Sequence[GcpConnectorInheritFromDelegateArgs]
    Inherit configuration from delegate.
    manual GcpConnectorManualArgs
    Manual credential configuration.
    name str
    Name of the resource.
    oidc_authentications Sequence[GcpConnectorOidcAuthenticationArgs]
    Authentication using harness oidc.
    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.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Enable this flag to execute on Delegate
    forceDelete Boolean
    Enable this flag for force deletion of connector
    identifier String
    Unique identifier of the resource.
    inheritFromDelegates List<Property Map>
    Inherit configuration from delegate.
    manual Property Map
    Manual credential configuration.
    name String
    Name of the resource.
    oidcAuthentications List<Property Map>
    Authentication using harness oidc.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Supporting Types

    GcpConnectorInheritFromDelegate, GcpConnectorInheritFromDelegateArgs

    DelegateSelectors List<string>
    The delegates to inherit the credentials from.
    DelegateSelectors []string
    The delegates to inherit the credentials from.
    delegateSelectors List<String>
    The delegates to inherit the credentials from.
    delegateSelectors string[]
    The delegates to inherit the credentials from.
    delegate_selectors Sequence[str]
    The delegates to inherit the credentials from.
    delegateSelectors List<String>
    The delegates to inherit the credentials from.

    GcpConnectorManual, GcpConnectorManualArgs

    SecretKeyRef string
    Reference to the Harness secret containing the secret key. 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>
    The delegates to connect with.
    SecretKeyRef string
    Reference to the Harness secret containing the secret key. 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
    The delegates to connect with.
    secretKeyRef String
    Reference to the Harness secret containing the secret key. 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>
    The delegates to connect with.
    secretKeyRef string
    Reference to the Harness secret containing the secret key. 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[]
    The delegates to connect with.
    secret_key_ref str
    Reference to the Harness secret containing the secret key. 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]
    The delegates to connect with.
    secretKeyRef String
    Reference to the Harness secret containing the secret key. 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>
    The delegates to connect with.

    GcpConnectorOidcAuthentication, GcpConnectorOidcAuthenticationArgs

    DelegateSelectors List<string>
    The delegates to inherit the credentials from.
    GcpProjectId string
    The project number of the GCP project that is used to create the workload identity.
    ProviderId string
    The OIDC provider ID value configured in GCP.
    ServiceAccountEmail string
    The service account linked to workload identity pool while setting GCP workload identity provider.
    WorkloadPoolId string
    The workload pool ID value created in GCP.
    DelegateSelectors []string
    The delegates to inherit the credentials from.
    GcpProjectId string
    The project number of the GCP project that is used to create the workload identity.
    ProviderId string
    The OIDC provider ID value configured in GCP.
    ServiceAccountEmail string
    The service account linked to workload identity pool while setting GCP workload identity provider.
    WorkloadPoolId string
    The workload pool ID value created in GCP.
    delegateSelectors List<String>
    The delegates to inherit the credentials from.
    gcpProjectId String
    The project number of the GCP project that is used to create the workload identity.
    providerId String
    The OIDC provider ID value configured in GCP.
    serviceAccountEmail String
    The service account linked to workload identity pool while setting GCP workload identity provider.
    workloadPoolId String
    The workload pool ID value created in GCP.
    delegateSelectors string[]
    The delegates to inherit the credentials from.
    gcpProjectId string
    The project number of the GCP project that is used to create the workload identity.
    providerId string
    The OIDC provider ID value configured in GCP.
    serviceAccountEmail string
    The service account linked to workload identity pool while setting GCP workload identity provider.
    workloadPoolId string
    The workload pool ID value created in GCP.
    delegate_selectors Sequence[str]
    The delegates to inherit the credentials from.
    gcp_project_id str
    The project number of the GCP project that is used to create the workload identity.
    provider_id str
    The OIDC provider ID value configured in GCP.
    service_account_email str
    The service account linked to workload identity pool while setting GCP workload identity provider.
    workload_pool_id str
    The workload pool ID value created in GCP.
    delegateSelectors List<String>
    The delegates to inherit the credentials from.
    gcpProjectId String
    The project number of the GCP project that is used to create the workload identity.
    providerId String
    The OIDC provider ID value configured in GCP.
    serviceAccountEmail String
    The service account linked to workload identity pool while setting GCP workload identity provider.
    workloadPoolId String
    The workload pool ID value created in GCP.

    Import

    Import account level gcp connector

    $ pulumi import harness:platform/gcpConnector:GcpConnector example <connector_id>

    Import org level gcp connector

    $ pulumi import harness:platform/gcpConnector:GcpConnector example <ord_id>/<connector_id>

    Import project level gcp connector

    $ pulumi import harness:platform/gcpConnector:GcpConnector example <org_id>/<project_id>/<connector_id>

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

    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.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness