Google Cloud Classic v8.9.3, Nov 18 24

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.developerconnect.Connection

Explore with Pulumi AI

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-gcp

Example Usage

Developer Connect Connection Basic

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

const my_connection = new gcp.developerconnect.Connection("my-connection", {
    location: "us-central1",
    connectionId: "tf-test-connection",
    githubConfig: {
        githubApp: "DEVELOPER_CONNECT",
        authorizerCredential: {
            oauthTokenSecretVersion: "projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1",
        },
    },
});

import pulumi
import pulumi_gcp as gcp

my_connection = gcp.developerconnect.Connection("my-connection",
    location="us-central1",
    connection_id="tf-test-connection",
    github_config={
        "github_app": "DEVELOPER_CONNECT",
        "authorizer_credential": {
            "oauth_token_secret_version": "projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1",
        },
    })

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/developerconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := developerconnect.NewConnection(ctx, "my-connection", &developerconnect.ConnectionArgs{
			Location:     pulumi.String("us-central1"),
			ConnectionId: pulumi.String("tf-test-connection"),
			GithubConfig: &developerconnect.ConnectionGithubConfigArgs{
				GithubApp: pulumi.String("DEVELOPER_CONNECT"),
				AuthorizerCredential: &developerconnect.ConnectionGithubConfigAuthorizerCredentialArgs{
					OauthTokenSecretVersion: pulumi.String("projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var my_connection = new Gcp.DeveloperConnect.Connection("my-connection", new()
    {
        Location = "us-central1",
        ConnectionId = "tf-test-connection",
        GithubConfig = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigArgs
        {
            GithubApp = "DEVELOPER_CONNECT",
            AuthorizerCredential = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigAuthorizerCredentialArgs
            {
                OauthTokenSecretVersion = "projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.developerconnect.Connection;
import com.pulumi.gcp.developerconnect.ConnectionArgs;
import com.pulumi.gcp.developerconnect.inputs.ConnectionGithubConfigArgs;
import com.pulumi.gcp.developerconnect.inputs.ConnectionGithubConfigAuthorizerCredentialArgs;
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 my_connection = new Connection("my-connection", ConnectionArgs.builder()
            .location("us-central1")
            .connectionId("tf-test-connection")
            .githubConfig(ConnectionGithubConfigArgs.builder()
                .githubApp("DEVELOPER_CONNECT")
                .authorizerCredential(ConnectionGithubConfigAuthorizerCredentialArgs.builder()
                    .oauthTokenSecretVersion("projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1")
                    .build())
                .build())
            .build());

    }
}

resources:
  my-connection:
    type: gcp:developerconnect:Connection
    properties:
      location: us-central1
      connectionId: tf-test-connection
      githubConfig:
        githubApp: DEVELOPER_CONNECT
        authorizerCredential:
          oauthTokenSecretVersion: projects/devconnect-terraform-creds/secrets/tf-test-do-not-change-github-oauthtoken-e0b9e7/versions/1

Developer Connect Connection Github Doc

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";

const github_token_secret = new gcp.secretmanager.Secret("github-token-secret", {
    secretId: "github-token-secret",
    replication: {
        auto: {},
    },
});
const github_token_secret_version = new gcp.secretmanager.SecretVersion("github-token-secret-version", {
    secret: github_token_secret.id,
    secretData: std.file({
        input: "my-github-token.txt",
    }).then(invoke => invoke.result),
});
const p4sa-secretAccessor = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/secretmanager.secretAccessor",
        members: ["serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com"],
    }],
});
const policy = new gcp.secretmanager.SecretIamPolicy("policy", {
    secretId: github_token_secret.secretId,
    policyData: p4sa_secretAccessor.then(p4sa_secretAccessor => p4sa_secretAccessor.policyData),
});
const my_connection = new gcp.developerconnect.Connection("my-connection", {
    location: "us-central1",
    connectionId: "my-connection",
    githubConfig: {
        githubApp: "DEVELOPER_CONNECT",
        appInstallationId: "123123",
        authorizerCredential: {
            oauthTokenSecretVersion: github_token_secret_version.id,
        },
    },
});

import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

github_token_secret = gcp.secretmanager.Secret("github-token-secret",
    secret_id="github-token-secret",
    replication={
        "auto": {},
    })
github_token_secret_version = gcp.secretmanager.SecretVersion("github-token-secret-version",
    secret=github_token_secret.id,
    secret_data=std.file(input="my-github-token.txt").result)
p4sa_secret_accessor = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/secretmanager.secretAccessor",
    "members": ["serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com"],
}])
policy = gcp.secretmanager.SecretIamPolicy("policy",
    secret_id=github_token_secret.secret_id,
    policy_data=p4sa_secret_accessor.policy_data)
my_connection = gcp.developerconnect.Connection("my-connection",
    location="us-central1",
    connection_id="my-connection",
    github_config={
        "github_app": "DEVELOPER_CONNECT",
        "app_installation_id": "123123",
        "authorizer_credential": {
            "oauth_token_secret_version": github_token_secret_version.id,
        },
    })

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/developerconnect"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/secretmanager"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secretmanager.NewSecret(ctx, "github-token-secret", &secretmanager.SecretArgs{
			SecretId: pulumi.String("github-token-secret"),
			Replication: &secretmanager.SecretReplicationArgs{
				Auto: &secretmanager.SecretReplicationAutoArgs{},
			},
		})
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "my-github-token.txt",
		}, nil)
		if err != nil {
			return err
		}
		_, err = secretmanager.NewSecretVersion(ctx, "github-token-secret-version", &secretmanager.SecretVersionArgs{
			Secret:     github_token_secret.ID(),
			SecretData: pulumi.String(invokeFile.Result),
		})
		if err != nil {
			return err
		}
		p4sa_secretAccessor, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/secretmanager.secretAccessor",
					Members: []string{
						"serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = secretmanager.NewSecretIamPolicy(ctx, "policy", &secretmanager.SecretIamPolicyArgs{
			SecretId:   github_token_secret.SecretId,
			PolicyData: pulumi.String(p4sa_secretAccessor.PolicyData),
		})
		if err != nil {
			return err
		}
		_, err = developerconnect.NewConnection(ctx, "my-connection", &developerconnect.ConnectionArgs{
			Location:     pulumi.String("us-central1"),
			ConnectionId: pulumi.String("my-connection"),
			GithubConfig: &developerconnect.ConnectionGithubConfigArgs{
				GithubApp:         pulumi.String("DEVELOPER_CONNECT"),
				AppInstallationId: pulumi.String("123123"),
				AuthorizerCredential: &developerconnect.ConnectionGithubConfigAuthorizerCredentialArgs{
					OauthTokenSecretVersion: github_token_secret_version.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var github_token_secret = new Gcp.SecretManager.Secret("github-token-secret", new()
    {
        SecretId = "github-token-secret",
        Replication = new Gcp.SecretManager.Inputs.SecretReplicationArgs
        {
            Auto = null,
        },
    });

    var github_token_secret_version = new Gcp.SecretManager.SecretVersion("github-token-secret-version", new()
    {
        Secret = github_token_secret.Id,
        SecretData = Std.File.Invoke(new()
        {
            Input = "my-github-token.txt",
        }).Apply(invoke => invoke.Result),
    });

    var p4sa_secretAccessor = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/secretmanager.secretAccessor",
                Members = new[]
                {
                    "serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com",
                },
            },
        },
    });

    var policy = new Gcp.SecretManager.SecretIamPolicy("policy", new()
    {
        SecretId = github_token_secret.SecretId,
        PolicyData = p4sa_secretAccessor.Apply(p4sa_secretAccessor => p4sa_secretAccessor.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData)),
    });

    var my_connection = new Gcp.DeveloperConnect.Connection("my-connection", new()
    {
        Location = "us-central1",
        ConnectionId = "my-connection",
        GithubConfig = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigArgs
        {
            GithubApp = "DEVELOPER_CONNECT",
            AppInstallationId = "123123",
            AuthorizerCredential = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigAuthorizerCredentialArgs
            {
                OauthTokenSecretVersion = github_token_secret_version.Id,
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.secretmanager.Secret;
import com.pulumi.gcp.secretmanager.SecretArgs;
import com.pulumi.gcp.secretmanager.inputs.SecretReplicationArgs;
import com.pulumi.gcp.secretmanager.inputs.SecretReplicationAutoArgs;
import com.pulumi.gcp.secretmanager.SecretVersion;
import com.pulumi.gcp.secretmanager.SecretVersionArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.secretmanager.SecretIamPolicy;
import com.pulumi.gcp.secretmanager.SecretIamPolicyArgs;
import com.pulumi.gcp.developerconnect.Connection;
import com.pulumi.gcp.developerconnect.ConnectionArgs;
import com.pulumi.gcp.developerconnect.inputs.ConnectionGithubConfigArgs;
import com.pulumi.gcp.developerconnect.inputs.ConnectionGithubConfigAuthorizerCredentialArgs;
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 github_token_secret = new Secret("github-token-secret", SecretArgs.builder()
            .secretId("github-token-secret")
            .replication(SecretReplicationArgs.builder()
                .auto()
                .build())
            .build());

        var github_token_secret_version = new SecretVersion("github-token-secret-version", SecretVersionArgs.builder()
            .secret(github_token_secret.id())
            .secretData(StdFunctions.file(FileArgs.builder()
                .input("my-github-token.txt")
                .build()).result())
            .build());

        final var p4sa-secretAccessor = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/secretmanager.secretAccessor")
                .members("serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com")
                .build())
            .build());

        var policy = new SecretIamPolicy("policy", SecretIamPolicyArgs.builder()
            .secretId(github_token_secret.secretId())
            .policyData(p4sa_secretAccessor.policyData())
            .build());

        var my_connection = new Connection("my-connection", ConnectionArgs.builder()
            .location("us-central1")
            .connectionId("my-connection")
            .githubConfig(ConnectionGithubConfigArgs.builder()
                .githubApp("DEVELOPER_CONNECT")
                .appInstallationId(123123)
                .authorizerCredential(ConnectionGithubConfigAuthorizerCredentialArgs.builder()
                    .oauthTokenSecretVersion(github_token_secret_version.id())
                    .build())
                .build())
            .build());

    }
}

resources:
  github-token-secret:
    type: gcp:secretmanager:Secret
    properties:
      secretId: github-token-secret
      replication:
        auto: {}
  github-token-secret-version:
    type: gcp:secretmanager:SecretVersion
    properties:
      secret: ${["github-token-secret"].id}
      secretData:
        fn::invoke:
          Function: std:file
          Arguments:
            input: my-github-token.txt
          Return: result
  policy:
    type: gcp:secretmanager:SecretIamPolicy
    properties:
      secretId: ${["github-token-secret"].secretId}
      policyData: ${["p4sa-secretAccessor"].policyData}
  my-connection:
    type: gcp:developerconnect:Connection
    properties:
      location: us-central1
      connectionId: my-connection
      githubConfig:
        githubApp: DEVELOPER_CONNECT
        appInstallationId: 123123
        authorizerCredential:
          oauthTokenSecretVersion: ${["github-token-secret-version"].id}
variables:
  p4sa-secretAccessor:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/secretmanager.secretAccessor
            members:
              - serviceAccount:service-123456789@gcp-sa-devconnect.iam.gserviceaccount.com

Create Connection Resource

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

Constructor syntax

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               connection_id: Optional[str] = None,
               location: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               disabled: Optional[bool] = None,
               etag: Optional[str] = None,
               github_config: Optional[ConnectionGithubConfigArgs] = None,
               labels: Optional[Mapping[str, str]] = None,
               project: Optional[str] = None)

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

type: gcp:developerconnect:Connection
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 ConnectionArgs: 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 ConnectionArgs: 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 ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConnectionArgs: 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 exampleconnectionResourceResourceFromDeveloperconnectconnection = new Gcp.DeveloperConnect.Connection("exampleconnectionResourceResourceFromDeveloperconnectconnection", new()
{
    ConnectionId = "string",
    Location = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Disabled = false,
    Etag = "string",
    GithubConfig = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigArgs
    {
        GithubApp = "string",
        AppInstallationId = "string",
        AuthorizerCredential = new Gcp.DeveloperConnect.Inputs.ConnectionGithubConfigAuthorizerCredentialArgs
        {
            OauthTokenSecretVersion = "string",
            Username = "string",
        },
        InstallationUri = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

example, err := developerconnect.NewConnection(ctx, "exampleconnectionResourceResourceFromDeveloperconnectconnection", &developerconnect.ConnectionArgs{
	ConnectionId: pulumi.String("string"),
	Location:     pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Disabled: pulumi.Bool(false),
	Etag:     pulumi.String("string"),
	GithubConfig: &developerconnect.ConnectionGithubConfigArgs{
		GithubApp:         pulumi.String("string"),
		AppInstallationId: pulumi.String("string"),
		AuthorizerCredential: &developerconnect.ConnectionGithubConfigAuthorizerCredentialArgs{
			OauthTokenSecretVersion: pulumi.String("string"),
			Username:                pulumi.String("string"),
		},
		InstallationUri: pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

var exampleconnectionResourceResourceFromDeveloperconnectconnection = new Connection("exampleconnectionResourceResourceFromDeveloperconnectconnection", ConnectionArgs.builder()
    .connectionId("string")
    .location("string")
    .annotations(Map.of("string", "string"))
    .disabled(false)
    .etag("string")
    .githubConfig(ConnectionGithubConfigArgs.builder()
        .githubApp("string")
        .appInstallationId("string")
        .authorizerCredential(ConnectionGithubConfigAuthorizerCredentialArgs.builder()
            .oauthTokenSecretVersion("string")
            .username("string")
            .build())
        .installationUri("string")
        .build())
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

exampleconnection_resource_resource_from_developerconnectconnection = gcp.developerconnect.Connection("exampleconnectionResourceResourceFromDeveloperconnectconnection",
    connection_id="string",
    location="string",
    annotations={
        "string": "string",
    },
    disabled=False,
    etag="string",
    github_config={
        "github_app": "string",
        "app_installation_id": "string",
        "authorizer_credential": {
            "oauth_token_secret_version": "string",
            "username": "string",
        },
        "installation_uri": "string",
    },
    labels={
        "string": "string",
    },
    project="string")

const exampleconnectionResourceResourceFromDeveloperconnectconnection = new gcp.developerconnect.Connection("exampleconnectionResourceResourceFromDeveloperconnectconnection", {
    connectionId: "string",
    location: "string",
    annotations: {
        string: "string",
    },
    disabled: false,
    etag: "string",
    githubConfig: {
        githubApp: "string",
        appInstallationId: "string",
        authorizerCredential: {
            oauthTokenSecretVersion: "string",
            username: "string",
        },
        installationUri: "string",
    },
    labels: {
        string: "string",
    },
    project: "string",
});

type: gcp:developerconnect:Connection
properties:
    annotations:
        string: string
    connectionId: string
    disabled: false
    etag: string
    githubConfig:
        appInstallationId: string
        authorizerCredential:
            oauthTokenSecretVersion: string
            username: string
        githubApp: string
        installationUri: string
    labels:
        string: string
    location: string
    project: string

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

ConnectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

Location string

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type developerconnect.googleapis.com/GitRepositoryLink.

Annotations Dictionary<string, string>

Optional. Allows clients to store small amounts of arbitrary data.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

Disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

Etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

GithubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

Labels Dictionary<string, string>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ConnectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

Location string

Annotations map[string]string

Optional. Allows clients to store small amounts of arbitrary data.

Disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

Etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

GithubConfig ConnectionGithubConfigArgs

Configuration for connections to github.com. Structure is documented below.

Labels map[string]string

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionId String

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

location String

annotations Map<String,String>

Optional. Allows clients to store small amounts of arbitrary data.

disabled Boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

etag String

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

labels Map<String,String>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

location string

annotations {[key: string]: string}

Optional. Allows clients to store small amounts of arbitrary data.

disabled boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

labels {[key: string]: string}

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connection_id str

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

location str

annotations Mapping[str, str]

Optional. Allows clients to store small amounts of arbitrary data.

disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

etag str

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

github_config ConnectionGithubConfigArgs

Configuration for connections to github.com. Structure is documented below.

labels Mapping[str, str]

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

connectionId String

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

location String

annotations Map<String>

Optional. Allows clients to store small amounts of arbitrary data.

disabled Boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

etag String

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig Property Map

Configuration for connections to github.com. Structure is documented below.

labels Map<String>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

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

CreateTime string: Output only. [Output only] Create timestamp
DeleteTime string: Output only. [Output only] Delete timestamp
EffectiveAnnotations Dictionary<string, string>
EffectiveLabels Dictionary<string, string>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string: The provider-assigned unique ID for this managed resource.
InstallationStates List<ConnectionInstallationState>: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
Name string: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
PulumiLabels Dictionary<string, string>: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Set to true when the connection is being set up or updated in the background.
Uid string: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
UpdateTime string: Output only. [Output only] Update timestamp

CreateTime string: Output only. [Output only] Create timestamp
DeleteTime string: Output only. [Output only] Delete timestamp
EffectiveAnnotations map[string]string
EffectiveLabels map[string]string: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string: The provider-assigned unique ID for this managed resource.
InstallationStates []ConnectionInstallationState: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
Name string: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
PulumiLabels map[string]string: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Set to true when the connection is being set up or updated in the background.
Uid string: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
UpdateTime string: Output only. [Output only] Update timestamp

createTime String: Output only. [Output only] Create timestamp
deleteTime String: Output only. [Output only] Delete timestamp
effectiveAnnotations Map<String,String>
effectiveLabels Map<String,String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String: The provider-assigned unique ID for this managed resource.
installationStates List<ConnectionInstallationState>: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
name String: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
pulumiLabels Map<String,String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Set to true when the connection is being set up or updated in the background.
uid String: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
updateTime String: Output only. [Output only] Update timestamp

createTime string: Output only. [Output only] Create timestamp
deleteTime string: Output only. [Output only] Delete timestamp
effectiveAnnotations {[key: string]: string}
effectiveLabels {[key: string]: string}: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id string: The provider-assigned unique ID for this managed resource.
installationStates ConnectionInstallationState[]: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
name string: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
pulumiLabels {[key: string]: string}: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling boolean: Output only. Set to true when the connection is being set up or updated in the background.
uid string: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
updateTime string: Output only. [Output only] Update timestamp

create_time str: Output only. [Output only] Create timestamp
delete_time str: Output only. [Output only] Delete timestamp
effective_annotations Mapping[str, str]
effective_labels Mapping[str, str]: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id str: The provider-assigned unique ID for this managed resource.
installation_states Sequence[ConnectionInstallationState]: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
name str: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
pulumi_labels Mapping[str, str]: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling bool: Output only. Set to true when the connection is being set up or updated in the background.
uid str: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
update_time str: Output only. [Output only] Update timestamp

createTime String: Output only. [Output only] Create timestamp
deleteTime String: Output only. [Output only] Delete timestamp
effectiveAnnotations Map<String>
effectiveLabels Map<String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String: The provider-assigned unique ID for this managed resource.
installationStates List<Property Map>: Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.
name String: Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.
pulumiLabels Map<String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Set to true when the connection is being set up or updated in the background.
uid String: Output only. A system-assigned unique identifier for a the GitRepositoryLink.
updateTime String: Output only. [Output only] Update timestamp

Look up Existing Connection Resource

Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        connection_id: Optional[str] = None,
        create_time: Optional[str] = None,
        delete_time: Optional[str] = None,
        disabled: Optional[bool] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        etag: Optional[str] = None,
        github_config: Optional[ConnectionGithubConfigArgs] = None,
        installation_states: Optional[Sequence[ConnectionInstallationStateArgs]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reconciling: Optional[bool] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Connection

func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)

public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)

public static Connection get(String name, Output<String> id, ConnectionState 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:

Annotations Dictionary<string, string>

Optional. Allows clients to store small amounts of arbitrary data.

ConnectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

CreateTime string

Output only. [Output only] Create timestamp

DeleteTime string

Output only. [Output only] Delete timestamp

Disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

EffectiveAnnotations Dictionary<string, string>

EffectiveLabels Dictionary<string, string>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

GithubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

InstallationStates List<ConnectionInstallationState>

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

Labels Dictionary<string, string>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Name string

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PulumiLabels Dictionary<string, string>

The combination of labels configured directly on the resource and default labels configured on the provider.

Reconciling bool

Output only. Set to true when the connection is being set up or updated in the background.

Uid string

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

UpdateTime string

Output only. [Output only] Update timestamp

Annotations map[string]string

Optional. Allows clients to store small amounts of arbitrary data.

ConnectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

CreateTime string

Output only. [Output only] Create timestamp

DeleteTime string

Output only. [Output only] Delete timestamp

Disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

EffectiveAnnotations map[string]string

EffectiveLabels map[string]string

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

GithubConfig ConnectionGithubConfigArgs

Configuration for connections to github.com. Structure is documented below.

InstallationStates []ConnectionInstallationStateArgs

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

Labels map[string]string

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Name string

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PulumiLabels map[string]string

The combination of labels configured directly on the resource and default labels configured on the provider.

Reconciling bool

Output only. Set to true when the connection is being set up or updated in the background.

Uid string

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

UpdateTime string

Output only. [Output only] Update timestamp

annotations Map<String,String>

Optional. Allows clients to store small amounts of arbitrary data.

connectionId String

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

createTime String

Output only. [Output only] Create timestamp

deleteTime String

Output only. [Output only] Delete timestamp

disabled Boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

effectiveAnnotations Map<String,String>

effectiveLabels Map<String,String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

etag String

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

installationStates List<ConnectionInstallationState>

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

labels Map<String,String>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

name String

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels Map<String,String>

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling Boolean

Output only. Set to true when the connection is being set up or updated in the background.

uid String

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

updateTime String

Output only. [Output only] Update timestamp

annotations {[key: string]: string}

Optional. Allows clients to store small amounts of arbitrary data.

connectionId string

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

createTime string

Output only. [Output only] Create timestamp

deleteTime string

Output only. [Output only] Delete timestamp

disabled boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

effectiveAnnotations {[key: string]: string}

effectiveLabels {[key: string]: string}

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

etag string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig ConnectionGithubConfig

Configuration for connections to github.com. Structure is documented below.

installationStates ConnectionInstallationState[]

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

labels {[key: string]: string}

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location string

name string

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels {[key: string]: string}

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling boolean

Output only. Set to true when the connection is being set up or updated in the background.

uid string

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

updateTime string

Output only. [Output only] Update timestamp

annotations Mapping[str, str]

Optional. Allows clients to store small amounts of arbitrary data.

connection_id str

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

create_time str

Output only. [Output only] Create timestamp

delete_time str

Output only. [Output only] Delete timestamp

disabled bool

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

effective_annotations Mapping[str, str]

effective_labels Mapping[str, str]

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

etag str

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

github_config ConnectionGithubConfigArgs

Configuration for connections to github.com. Structure is documented below.

installation_states Sequence[ConnectionInstallationStateArgs]

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

labels Mapping[str, str]

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location str

name str

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_labels Mapping[str, str]

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling bool

Output only. Set to true when the connection is being set up or updated in the background.

uid str

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

update_time str

Output only. [Output only] Update timestamp

annotations Map<String>

Optional. Allows clients to store small amounts of arbitrary data.

connectionId String

Required. Id of the requesting object. If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC.

createTime String

Output only. [Output only] Create timestamp

deleteTime String

Output only. [Output only] Delete timestamp

disabled Boolean

Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

effectiveAnnotations Map<String>

effectiveLabels Map<String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

etag String

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

githubConfig Property Map

Configuration for connections to github.com. Structure is documented below.

installationStates List<Property Map>

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. Structure is documented below.

labels Map<String>

Optional. Labels as key value pairs

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

name String

Identifier. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels Map<String>

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling Boolean

Output only. Set to true when the connection is being set up or updated in the background.

uid String

Output only. A system-assigned unique identifier for a the GitRepositoryLink.

updateTime String

Output only. [Output only] Update timestamp

Supporting Types

ConnectionGithubConfig, ConnectionGithubConfigArgs

GithubApp string: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
AppInstallationId string: Optional. GitHub App installation id.
AuthorizerCredential ConnectionGithubConfigAuthorizerCredential: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
InstallationUri string: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

GithubApp string: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
AppInstallationId string: Optional. GitHub App installation id.
AuthorizerCredential ConnectionGithubConfigAuthorizerCredential: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
InstallationUri string: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

githubApp String: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
appInstallationId String: Optional. GitHub App installation id.
authorizerCredential ConnectionGithubConfigAuthorizerCredential: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
installationUri String: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

githubApp string: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
appInstallationId string: Optional. GitHub App installation id.
authorizerCredential ConnectionGithubConfigAuthorizerCredential: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
installationUri string: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

github_app str: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
app_installation_id str: Optional. GitHub App installation id.
authorizer_credential ConnectionGithubConfigAuthorizerCredential: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
installation_uri str: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

githubApp String: Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. Possible values: GIT_HUB_APP_UNSPECIFIED DEVELOPER_CONNECT FIREBASE"
appInstallationId String: Optional. GitHub App installation id.
authorizerCredential Property Map: Represents an OAuth token of the account that authorized the Connection,and associated metadata. Structure is documented below.
installationUri String: (Output) Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

ConnectionGithubConfigAuthorizerCredential, ConnectionGithubConfigAuthorizerCredentialArgs

OauthTokenSecretVersion string: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
Username string: (Output) Output only. The username associated with this token.

OauthTokenSecretVersion string: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
Username string: (Output) Output only. The username associated with this token.

oauthTokenSecretVersion String: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
username String: (Output) Output only. The username associated with this token.

oauthTokenSecretVersion string: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
username string: (Output) Output only. The username associated with this token.

oauth_token_secret_version str: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
username str: (Output) Output only. The username associated with this token.

oauthTokenSecretVersion String: Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/*.
username String: (Output) Output only. The username associated with this token.

ConnectionInstallationState, ConnectionInstallationStateArgs

ActionUri string: Output only. Link to follow for next action. Empty string if the installation is already complete.
Message string: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
Stage string: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

ActionUri string: Output only. Link to follow for next action. Empty string if the installation is already complete.
Message string: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
Stage string: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

actionUri String: Output only. Link to follow for next action. Empty string if the installation is already complete.
message String: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
stage String: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

actionUri string: Output only. Link to follow for next action. Empty string if the installation is already complete.
message string: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
stage string: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

action_uri str: Output only. Link to follow for next action. Empty string if the installation is already complete.
message str: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
stage str: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

actionUri String: Output only. Link to follow for next action. Empty string if the installation is already complete.
message String: Output only. Message of what the user should do next to continue the installation.Empty string if the installation is already complete.
stage String: (Output) Output only. Current step of the installation process. Possible values: STAGE_UNSPECIFIED PENDING_CREATE_APP PENDING_USER_OAUTH PENDING_INSTALL_APP COMPLETE

Import

Connection can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/connections/{{connection_id}}
{{project}}/{{location}}/{{connection_id}}
{{location}}/{{connection_id}}

When using the pulumi import command, Connection can be imported using one of the formats above. For example:

$ pulumi import gcp:developerconnect/connection:Connection default projects/{{project}}/locations/{{location}}/connections/{{connection_id}}

$ pulumi import gcp:developerconnect/connection:Connection default {{project}}/{{location}}/{{connection_id}}

$ pulumi import gcp:developerconnect/connection:Connection default {{location}}/{{connection_id}}

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

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.developerconnect.Connection

On this page

On this page

Example Usage

Developer Connect Connection Basic

Developer Connect Connection Github Doc

Create Connection Resource

Constructor syntax

Parameters

Constructor example

Connection Resource Properties

Inputs

Outputs

Look up Existing Connection Resource

Supporting Types

ConnectionGithubConfig, ConnectionGithubConfigArgs

ConnectionGithubConfigAuthorizerCredential, ConnectionGithubConfigAuthorizerCredentialArgs

ConnectionInstallationState, ConnectionInstallationStateArgs

Import

Package Details

On this page

On this page