dynatrace.GithubConnection

This resource requires the API token scopes Read settings (settings.read) and Write settings (settings.write)

This resource requires the OAuth scopes Read settings (settings:objects:read) and Write settings (settings:objects:write)

Limitations

Warning If a resource is created using an API token or without setting DYNATRACE_HTTP_OAUTH_PREFERENCE=true (when both are used), the settings object’s owner will remain empty.

An empty owner implies:

• The settings object becomes public, allowing other users with settings permissions to read and modify it.
• Changing the settings object’s permissions will have no effect, meaning the dynatrace.SettingsPermissions resource can’t alter its access.

When a settings object is created using platform credentials:

• The owner is set to the owner of the OAuth client or platform token.
• By default, the settings object is private; only the owner can read and modify it.
• Access modifiers can be managed using the dynatrace.SettingsPermissions resource.

We recommend using platform credentials to ensure a correct setup. In case an API token is needed, we recommend setting DYNATRACE_HTTP_OAUTH_PREFERENCE=true.

Dynatrace Documentation

• GitHub for Workflows - https://docs.dynatrace.com/docs/analyze-explore-automate/workflows/actions/github

• Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: app:dynatrace.github.connector:connection)

Export Example Usage

• terraform-provider-dynatrace -export dynatrace.GithubConnection downloads all existing GitHub connections

The full documentation of the export feature is available here.

Create GithubConnection Resource

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

Constructor syntax

new GithubConnection(name: string, args: GithubConnectionArgs, opts?: CustomResourceOptions);

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

@overload
def GithubConnection(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     type: Optional[str] = None,
                     name: Optional[str] = None,
                     token: Optional[str] = None)

func NewGithubConnection(ctx *Context, name string, args GithubConnectionArgs, opts ...ResourceOption) (*GithubConnection, error)

public GithubConnection(string name, GithubConnectionArgs args, CustomResourceOptions? opts = null)

public GithubConnection(String name, GithubConnectionArgs args)
public GithubConnection(String name, GithubConnectionArgs args, CustomResourceOptions options)

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

resource "dynatrace_githubconnection" "name" {
    # resource properties
}

Parameters

Constructor example

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

var githubConnectionResource = new Dynatrace.GithubConnection("githubConnectionResource", new()
{
    Type = "string",
    Name = "string",
    Token = "string",
});

example, err := dynatrace.NewGithubConnection(ctx, "githubConnectionResource", &dynatrace.GithubConnectionArgs{
	Type:  pulumi.String("string"),
	Name:  pulumi.String("string"),
	Token: pulumi.String("string"),
})

resource "dynatrace_githubconnection" "githubConnectionResource" {
  type  = "string"
  name  = "string"
  token = "string"
}

var githubConnectionResource = new GithubConnection("githubConnectionResource", GithubConnectionArgs.builder()
    .type("string")
    .name("string")
    .token("string")
    .build());

github_connection_resource = dynatrace.GithubConnection("githubConnectionResource",
    type="string",
    name="string",
    token="string")

const githubConnectionResource = new dynatrace.GithubConnection("githubConnectionResource", {
    type: "string",
    name: "string",
    token: "string",
});

type: dynatrace:GithubConnection
properties:
    name: string
    token: string
    type: string

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

Outputs

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

Look up Existing GithubConnection Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        token: Optional[str] = None,
        type: Optional[str] = None) -> GithubConnection

func GetGithubConnection(ctx *Context, name string, id IDInput, state *GithubConnectionState, opts ...ResourceOption) (*GithubConnection, error)

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

public static GithubConnection get(String name, Output<String> id, GithubConnectionState state, CustomResourceOptions options)

resources:  _:    type: dynatrace:GithubConnection    get:      id: ${id}

import {
  to = dynatrace_githubconnection.example
  id = "${id}"
}

Package Details

Repository

dynatrace pulumiverse/pulumi-dynatrace

License

Apache-2.0

Notes

This Pulumi package is based on the dynatrace Terraform Provider.