Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. ActionGatewayConnection
Viewing docs for DigitalOcean v4.85.0
published on Saturday, Nov 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

digitalocean.ActionGatewayConnection

digitalocean logo
Viewing docs for DigitalOcean v4.85.0
published on Saturday, Nov 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

    Provides a DigitalOcean Action Gateway connection resource. A connection authorizes a tool provider, such as GitHub, Jira, or Linear, to act on an account for one actor ID. Sessions whose actor ID matches the connection’s userId use it for that provider’s tools.

    Note: A connection belongs to the DigitalOcean user who owns the API token Terraform uses, within that token’s team. Other team members cannot use it, even with the same userId. To let team members create their own connections from a shared credential, register the provider credential in the control panel, make it reusable by the team, and pass its ID as credentialId.

    An OAuth connection starts pending. The account holder completes it by opening authorization.0.connect_url, which is exported as a sensitive value while the connection is pending. A connection through a team API-key credential is active immediately.

    Example Usage

    Team provider credential

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

const linear = new digitalocean.ActionGatewayConnection("linear", {
    toolProvider: "linear",
    userId: "support-bot",
    credentialId: "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b",
});

    import pulumi
import pulumi_digitalocean as digitalocean

linear = digitalocean.ActionGatewayConnection("linear",
    tool_provider="linear",
    user_id="support-bot",
    credential_id="8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b")

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.NewActionGatewayConnection(ctx, "linear", &digitalocean.ActionGatewayConnectionArgs{
			ToolProvider: pulumi.String("linear"),
			UserId:       pulumi.String("support-bot"),
			CredentialId: pulumi.String("8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var linear = new DigitalOcean.ActionGatewayConnection("linear", new()
    {
        ToolProvider = "linear",
        UserId = "support-bot",
        CredentialId = "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.ActionGatewayConnection;
import com.pulumi.digitalocean.ActionGatewayConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 linear = new ActionGatewayConnection("linear", ActionGatewayConnectionArgs.builder()
            .toolProvider("linear")
            .userId("support-bot")
            .credentialId("8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b")
            .build());

    }
}

    resources:
  linear:
    type: digitalocean:ActionGatewayConnection
    properties:
      toolProvider: linear
      userId: support-bot
      credentialId: 8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b

    terraform {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

resource "digitalocean_action_gateway_connection" "linear" {
  lifecycle {
    create_before_destroy = true
  }
  tool_provider = "linear"
  user_id       = "support-bot"
  credential_id = "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b"
}

    Private network

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

const example = new digitalocean.Vpc("example", {
    name: "example-vpc",
    region: "ric1",
});
const privateJira = new digitalocean.ActionGatewayConnection("private_jira", {
    toolProvider: "jira",
    userId: "user-123",
    credentialId: "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b",
    connectionParameters: {
        site_url: "https://jira.internal.example.com",
    },
    vpc: {
        vpcUuid: example.id,
        destinations: [{
            host: "jira.internal.example.com",
            port: 443,
            allowedIpCidrs: ["10.116.0.0/20"],
        }],
    },
});

    import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.Vpc("example",
    name="example-vpc",
    region="ric1")
private_jira = digitalocean.ActionGatewayConnection("private_jira",
    tool_provider="jira",
    user_id="user-123",
    credential_id="8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b",
    connection_parameters={
        "site_url": "https://jira.internal.example.com",
    },
    vpc={
        "vpc_uuid": example.id,
        "destinations": [{
            "host": "jira.internal.example.com",
            "port": 443,
            "allowed_ip_cidrs": ["10.116.0.0/20"],
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := digitalocean.NewVpc(ctx, "example", &digitalocean.VpcArgs{
			Name:   pulumi.String("example-vpc"),
			Region: pulumi.String("ric1"),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewActionGatewayConnection(ctx, "private_jira", &digitalocean.ActionGatewayConnectionArgs{
			ToolProvider: pulumi.String("jira"),
			UserId:       pulumi.String("user-123"),
			CredentialId: pulumi.String("8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b"),
			ConnectionParameters: pulumi.StringMap{
				"site_url": pulumi.String("https://jira.internal.example.com"),
			},
			Vpc: &digitalocean.ActionGatewayConnectionVpcArgs{
				VpcUuid: example.ID(),
				Destinations: digitalocean.ActionGatewayConnectionVpcDestinationArray{
					&digitalocean.ActionGatewayConnectionVpcDestinationArgs{
						Host: pulumi.String("jira.internal.example.com"),
						Port: pulumi.Int(443),
						AllowedIpCidrs: pulumi.StringArray{
							pulumi.String("10.116.0.0/20"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new DigitalOcean.Vpc("example", new()
    {
        Name = "example-vpc",
        Region = "ric1",
    });

    var privateJira = new DigitalOcean.ActionGatewayConnection("private_jira", new()
    {
        ToolProvider = "jira",
        UserId = "user-123",
        CredentialId = "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b",
        ConnectionParameters = 
        {
            { "site_url", "https://jira.internal.example.com" },
        },
        Vpc = new DigitalOcean.Inputs.ActionGatewayConnectionVpcArgs
        {
            VpcUuid = example.Id,
            Destinations = new[]
            {
                new DigitalOcean.Inputs.ActionGatewayConnectionVpcDestinationArgs
                {
                    Host = "jira.internal.example.com",
                    Port = 443,
                    AllowedIpCidrs = new[]
                    {
                        "10.116.0.0/20",
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.Vpc;
import com.pulumi.digitalocean.VpcArgs;
import com.pulumi.digitalocean.ActionGatewayConnection;
import com.pulumi.digitalocean.ActionGatewayConnectionArgs;
import com.pulumi.digitalocean.inputs.ActionGatewayConnectionVpcArgs;
import com.pulumi.digitalocean.inputs.ActionGatewayConnectionVpcDestinationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Vpc("example", VpcArgs.builder()
            .name("example-vpc")
            .region("ric1")
            .build());

        var privateJira = new ActionGatewayConnection("privateJira", ActionGatewayConnectionArgs.builder()
            .toolProvider("jira")
            .userId("user-123")
            .credentialId("8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b")
            .connectionParameters(Map.of("site_url", "https://jira.internal.example.com"))
            .vpc(ActionGatewayConnectionVpcArgs.builder()
                .vpcUuid(example.id())
                .destinations(ActionGatewayConnectionVpcDestinationArgs.builder()
                    .host("jira.internal.example.com")
                    .port(443)
                    .allowedIpCidrs("10.116.0.0/20")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: digitalocean:Vpc
    properties:
      name: example-vpc
      region: ric1
  privateJira:
    type: digitalocean:ActionGatewayConnection
    name: private_jira
    properties:
      toolProvider: jira
      userId: user-123
      credentialId: 8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b
      connectionParameters:
        site_url: https://jira.internal.example.com
      vpc:
        vpcUuid: ${example.id}
        destinations:
          - host: jira.internal.example.com
            port: 443
            allowedIpCidrs:
              - 10.116.0.0/20

    terraform {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

resource "digitalocean_vpc" "example" {
  lifecycle {
    create_before_destroy = true
  }
  name   = "example-vpc"
  region = "ric1"
}
resource "digitalocean_action_gateway_connection" "private_jira" {
  lifecycle {
    create_before_destroy = true
  }
  tool_provider = "jira"
  user_id       = "user-123"
  credential_id = "8d6f2b1a-3c4e-4d5f-9a8b-7c6d5e4f3a2b"
  connection_parameters = {
    "site_url" = "https://jira.internal.example.com"
  }
  vpc {
    vpc_uuid = digitalocean_vpc.example.id
    destination {
      host             = "jira.internal.example.com"
      port             = 443
      allowed_ip_cidrs = ["10.116.0.0/20"]
    }
  }
}

    Create ActionGatewayConnection Resource

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

    Constructor syntax

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

@overload
def ActionGatewayConnection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            tool_provider: Optional[str] = None,
                            user_id: Optional[str] = None,
                            connection_parameters: Optional[Mapping[str, str]] = None,
                            credential_id: Optional[str] = None,
                            scopes: Optional[Sequence[str]] = None,
                            vpc: Optional[ActionGatewayConnectionVpcArgs] = None)
    func NewActionGatewayConnection(ctx *Context, name string, args ActionGatewayConnectionArgs, opts ...ResourceOption) (*ActionGatewayConnection, error)
    public ActionGatewayConnection(string name, ActionGatewayConnectionArgs args, CustomResourceOptions? opts = null)
    public ActionGatewayConnection(String name, ActionGatewayConnectionArgs args)
public ActionGatewayConnection(String name, ActionGatewayConnectionArgs args, CustomResourceOptions options)

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


    resource "digitalocean_action_gateway_connection" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ActionGatewayConnectionArgs
    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 ActionGatewayConnectionArgs
    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 ActionGatewayConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionGatewayConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionGatewayConnectionArgs
    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 actionGatewayConnectionResource = new DigitalOcean.ActionGatewayConnection("actionGatewayConnectionResource", new()
{
    ToolProvider = "string",
    UserId = "string",
    ConnectionParameters = 
    {
        { "string", "string" },
    },
    CredentialId = "string",
    Scopes = new[]
    {
        "string",
    },
    Vpc = new DigitalOcean.Inputs.ActionGatewayConnectionVpcArgs
    {
        Destinations = new[]
        {
            new DigitalOcean.Inputs.ActionGatewayConnectionVpcDestinationArgs
            {
                Host = "string",
                Port = 0,
                AllowedIpCidrs = new[]
                {
                    "string",
                },
            },
        },
        VpcUuid = "string",
        Region = "string",
    },
});

    example, err := digitalocean.NewActionGatewayConnection(ctx, "actionGatewayConnectionResource", &digitalocean.ActionGatewayConnectionArgs{
	ToolProvider: pulumi.String("string"),
	UserId:       pulumi.String("string"),
	ConnectionParameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CredentialId: pulumi.String("string"),
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Vpc: &digitalocean.ActionGatewayConnectionVpcArgs{
		Destinations: digitalocean.ActionGatewayConnectionVpcDestinationArray{
			&digitalocean.ActionGatewayConnectionVpcDestinationArgs{
				Host: pulumi.String("string"),
				Port: pulumi.Int(0),
				AllowedIpCidrs: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		VpcUuid: pulumi.String("string"),
		Region:  pulumi.String("string"),
	},
})

    resource "digitalocean_action_gateway_connection" "actionGatewayConnectionResource" {
  lifecycle {
    create_before_destroy = true
  }
  tool_provider = "string"
  user_id       = "string"
  connection_parameters = {
    "string" = "string"
  }
  credential_id = "string"
  scopes        = ["string"]
  vpc = {
    destinations = [{
      host             = "string"
      port             = 0
      allowed_ip_cidrs = ["string"]
    }]
    vpc_uuid = "string"
    region   = "string"
  }
}

    var actionGatewayConnectionResource = new ActionGatewayConnection("actionGatewayConnectionResource", ActionGatewayConnectionArgs.builder()
    .toolProvider("string")
    .userId("string")
    .connectionParameters(Map.of("string", "string"))
    .credentialId("string")
    .scopes("string")
    .vpc(ActionGatewayConnectionVpcArgs.builder()
        .destinations(ActionGatewayConnectionVpcDestinationArgs.builder()
            .host("string")
            .port(0)
            .allowedIpCidrs("string")
            .build())
        .vpcUuid("string")
        .region("string")
        .build())
    .build());

    action_gateway_connection_resource = digitalocean.ActionGatewayConnection("actionGatewayConnectionResource",
    tool_provider="string",
    user_id="string",
    connection_parameters={
        "string": "string",
    },
    credential_id="string",
    scopes=["string"],
    vpc={
        "destinations": [{
            "host": "string",
            "port": 0,
            "allowed_ip_cidrs": ["string"],
        }],
        "vpc_uuid": "string",
        "region": "string",
    })

    const actionGatewayConnectionResource = new digitalocean.ActionGatewayConnection("actionGatewayConnectionResource", {
    toolProvider: "string",
    userId: "string",
    connectionParameters: {
        string: "string",
    },
    credentialId: "string",
    scopes: ["string"],
    vpc: {
        destinations: [{
            host: "string",
            port: 0,
            allowedIpCidrs: ["string"],
        }],
        vpcUuid: "string",
        region: "string",
    },
});

    type: digitalocean:ActionGatewayConnection
properties:
    connectionParameters:
        string: string
    credentialId: string
    scopes:
        - string
    toolProvider: string
    userId: string
    vpc:
        destinations:
            - allowedIpCidrs:
                - string
              host: string
              port: 0
        region: string
        vpcUuid: string

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

    ToolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    UserId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    ConnectionParameters Dictionary<string, string>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    CredentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    Scopes List<string>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    Vpc Pulumi.DigitalOcean.Inputs.ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    ToolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    UserId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    ConnectionParameters map[string]string
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    CredentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    Scopes []string
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    Vpc ActionGatewayConnectionVpcArgs
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    tool_provider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    user_id string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    connection_parameters map(string)
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    credential_id string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    scopes list(string)
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    vpc object
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    toolProvider String
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    userId String
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    connectionParameters Map<String,String>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    credentialId String
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    scopes List<String>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    vpc ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    toolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    userId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    connectionParameters {[key: string]: string}
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    credentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    scopes string[]
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    vpc ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    tool_provider str
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    user_id str
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    connection_parameters Mapping[str, str]
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    credential_id str
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    scopes Sequence[str]
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    vpc ActionGatewayConnectionVpcArgs
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    toolProvider String
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    userId String
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    connectionParameters Map<String>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    credentialId String
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    scopes List<String>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    vpc Property Map
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.

    Outputs

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

    Authorizations List<Pulumi.DigitalOcean.Outputs.ActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    CreatedAt string
    When the connection was created.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Status string
    The status of the authorization.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    Authorizations []ActionGatewayConnectionAuthorization
    The authorization the account holder still has to complete. Set only while the connection is pending.
    CreatedAt string
    When the connection was created.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Status string
    The status of the authorization.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    authorizations list(object)
    The authorization the account holder still has to complete. Set only while the connection is pending.
    created_at string
    When the connection was created.
    credential_kind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at string
    When the account holder completed authorization.
    id string
    The provider-assigned unique ID for this managed resource.
    owning_user_id string
    The DigitalOcean user ID of the user who created the connection.
    status string
    The status of the authorization.
    tool_provider_display_name string
    The human-readable name of the tool provider.
    updated_at string
    When the connection was last modified.
    authorizations List<ActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    createdAt String
    When the connection was created.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    id String
    The provider-assigned unique ID for this managed resource.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    status String
    The status of the authorization.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.
    authorizations ActionGatewayConnectionAuthorization[]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    createdAt string
    When the connection was created.
    credentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt string
    When the account holder completed authorization.
    id string
    The provider-assigned unique ID for this managed resource.
    owningUserId string
    The DigitalOcean user ID of the user who created the connection.
    status string
    The status of the authorization.
    toolProviderDisplayName string
    The human-readable name of the tool provider.
    updatedAt string
    When the connection was last modified.
    authorizations Sequence[ActionGatewayConnectionAuthorization]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    created_at str
    When the connection was created.
    credential_kind str
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at str
    When the account holder completed authorization.
    id str
    The provider-assigned unique ID for this managed resource.
    owning_user_id str
    The DigitalOcean user ID of the user who created the connection.
    status str
    The status of the authorization.
    tool_provider_display_name str
    The human-readable name of the tool provider.
    updated_at str
    When the connection was last modified.
    authorizations List<Property Map>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    createdAt String
    When the connection was created.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    id String
    The provider-assigned unique ID for this managed resource.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    status String
    The status of the authorization.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.

    Look up Existing ActionGatewayConnection Resource

    Get an existing ActionGatewayConnection 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?: ActionGatewayConnectionState, opts?: CustomResourceOptions): ActionGatewayConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorizations: Optional[Sequence[ActionGatewayConnectionAuthorizationArgs]] = None,
        connection_parameters: Optional[Mapping[str, str]] = None,
        created_at: Optional[str] = None,
        credential_id: Optional[str] = None,
        credential_kind: Optional[str] = None,
        granted_at: Optional[str] = None,
        owning_user_id: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tool_provider: Optional[str] = None,
        tool_provider_display_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        user_id: Optional[str] = None,
        vpc: Optional[ActionGatewayConnectionVpcArgs] = None) -> ActionGatewayConnection
    func GetActionGatewayConnection(ctx *Context, name string, id IDInput, state *ActionGatewayConnectionState, opts ...ResourceOption) (*ActionGatewayConnection, error)
    public static ActionGatewayConnection Get(string name, Input<string> id, ActionGatewayConnectionState? state, CustomResourceOptions? opts = null)
    public static ActionGatewayConnection get(String name, Output<String> id, ActionGatewayConnectionState state, CustomResourceOptions options)
    resources:  _:    type: digitalocean:ActionGatewayConnection    get:      id: ${id}
    import {
  to = digitalocean_action_gateway_connection.example
  id = "${id}"
}
    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:
    Authorizations List<Pulumi.DigitalOcean.Inputs.ActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    ConnectionParameters Dictionary<string, string>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    CreatedAt string
    When the connection was created.
    CredentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Scopes List<string>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    Status string
    The status of the authorization.
    ToolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    UserId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    Vpc Pulumi.DigitalOcean.Inputs.ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    Authorizations []ActionGatewayConnectionAuthorizationArgs
    The authorization the account holder still has to complete. Set only while the connection is pending.
    ConnectionParameters map[string]string
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    CreatedAt string
    When the connection was created.
    CredentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Scopes []string
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    Status string
    The status of the authorization.
    ToolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    UserId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    Vpc ActionGatewayConnectionVpcArgs
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    authorizations list(object)
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connection_parameters map(string)
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    created_at string
    When the connection was created.
    credential_id string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    credential_kind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at string
    When the account holder completed authorization.
    owning_user_id string
    The DigitalOcean user ID of the user who created the connection.
    scopes list(string)
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    status string
    The status of the authorization.
    tool_provider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    tool_provider_display_name string
    The human-readable name of the tool provider.
    updated_at string
    When the connection was last modified.
    user_id string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    vpc object
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    authorizations List<ActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters Map<String,String>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    createdAt String
    When the connection was created.
    credentialId String
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    scopes List<String>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    status String
    The status of the authorization.
    toolProvider String
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.
    userId String
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    vpc ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    authorizations ActionGatewayConnectionAuthorization[]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters {[key: string]: string}
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    createdAt string
    When the connection was created.
    credentialId string
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    credentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt string
    When the account holder completed authorization.
    owningUserId string
    The DigitalOcean user ID of the user who created the connection.
    scopes string[]
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    status string
    The status of the authorization.
    toolProvider string
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    toolProviderDisplayName string
    The human-readable name of the tool provider.
    updatedAt string
    When the connection was last modified.
    userId string
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    vpc ActionGatewayConnectionVpc
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    authorizations Sequence[ActionGatewayConnectionAuthorizationArgs]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connection_parameters Mapping[str, str]
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    created_at str
    When the connection was created.
    credential_id str
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    credential_kind str
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at str
    When the account holder completed authorization.
    owning_user_id str
    The DigitalOcean user ID of the user who created the connection.
    scopes Sequence[str]
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    status str
    The status of the authorization.
    tool_provider str
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    tool_provider_display_name str
    The human-readable name of the tool provider.
    updated_at str
    When the connection was last modified.
    user_id str
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    vpc ActionGatewayConnectionVpcArgs
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.
    authorizations List<Property Map>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters Map<String>
    A map of values for the provider's connection parameters, such as siteUrl for Jira.
    createdAt String
    When the connection was created.
    credentialId String
    The ID of a team provider credential, such as your own OAuth application or an API key, to connect through. When omitted, DigitalOcean's shared OAuth application is used.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    scopes List<String>
    The OAuth scopes to request. When omitted or empty, every scope the provider offers is requested. Ignored for API-key credentials.
    status String
    The status of the authorization.
    toolProvider String
    The slug of the tool provider, such as github or jira. The digitalocean.getActionGatewayProviders data source lists the available providers.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.
    userId String
    The actor ID the connection acts for: 1 to 64 characters from [A-Za-z0-9._-]. Use the actor ID of the sessions that need this account.
    vpc Property Map
    Routes the connection's calls through a VPC. VPC networking must be enabled for your team.

    Supporting Types

    ActionGatewayConnectionAuthorization, ActionGatewayConnectionAuthorizationArgs

    ConnectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    ExpiresAt string
    When the authorization link expires.
    Status string
    The status of the authorization.
    VerificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    ConnectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    ExpiresAt string
    When the authorization link expires.
    Status string
    The status of the authorization.
    VerificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    connect_url string
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    expires_at string
    When the authorization link expires.
    status string
    The status of the authorization.
    verification_code string
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl String
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    expiresAt String
    When the authorization link expires.
    status String
    The status of the authorization.
    verificationCode String
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    expiresAt string
    When the authorization link expires.
    status string
    The status of the authorization.
    verificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    connect_url str
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    expires_at str
    When the authorization link expires.
    status str
    The status of the authorization.
    verification_code str
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl String
    (Sensitive) The URL the account holder opens to authorize the provider. Share it only with the intended account holder.
    expiresAt String
    When the authorization link expires.
    status String
    The status of the authorization.
    verificationCode String
    (Sensitive) The code the account holder confirms during authorization.

    ActionGatewayConnectionVpc, ActionGatewayConnectionVpcArgs

    Destinations List<Pulumi.DigitalOcean.Inputs.ActionGatewayConnectionVpcDestination>
    One or more private hosts the connection's calls may reach.
    VpcUuid string
    The UUID of a VPC owned by your team.
    Region string
    The region of the connection's VPC.
    Destinations []ActionGatewayConnectionVpcDestination
    One or more private hosts the connection's calls may reach.
    VpcUuid string
    The UUID of a VPC owned by your team.
    Region string
    The region of the connection's VPC.
    destinations list(object)
    One or more private hosts the connection's calls may reach.
    vpc_uuid string
    The UUID of a VPC owned by your team.
    region string
    The region of the connection's VPC.
    destinations List<ActionGatewayConnectionVpcDestination>
    One or more private hosts the connection's calls may reach.
    vpcUuid String
    The UUID of a VPC owned by your team.
    region String
    The region of the connection's VPC.
    destinations ActionGatewayConnectionVpcDestination[]
    One or more private hosts the connection's calls may reach.
    vpcUuid string
    The UUID of a VPC owned by your team.
    region string
    The region of the connection's VPC.
    destinations Sequence[ActionGatewayConnectionVpcDestination]
    One or more private hosts the connection's calls may reach.
    vpc_uuid str
    The UUID of a VPC owned by your team.
    region str
    The region of the connection's VPC.
    destinations List<Property Map>
    One or more private hosts the connection's calls may reach.
    vpcUuid String
    The UUID of a VPC owned by your team.
    region String
    The region of the connection's VPC.

    ActionGatewayConnectionVpcDestination, ActionGatewayConnectionVpcDestinationArgs

    Host string
    A host name or IP address that resolves only to private addresses.
    Port int
    The destination port.
    AllowedIpCidrs List<string>
    CIDR ranges that every address the host resolves to must fall within.
    Host string
    A host name or IP address that resolves only to private addresses.
    Port int
    The destination port.
    AllowedIpCidrs []string
    CIDR ranges that every address the host resolves to must fall within.
    host string
    A host name or IP address that resolves only to private addresses.
    port number
    The destination port.
    allowed_ip_cidrs list(string)
    CIDR ranges that every address the host resolves to must fall within.
    host String
    A host name or IP address that resolves only to private addresses.
    port Integer
    The destination port.
    allowedIpCidrs List<String>
    CIDR ranges that every address the host resolves to must fall within.
    host string
    A host name or IP address that resolves only to private addresses.
    port number
    The destination port.
    allowedIpCidrs string[]
    CIDR ranges that every address the host resolves to must fall within.
    host str
    A host name or IP address that resolves only to private addresses.
    port int
    The destination port.
    allowed_ip_cidrs Sequence[str]
    CIDR ranges that every address the host resolves to must fall within.
    host String
    A host name or IP address that resolves only to private addresses.
    port Number
    The destination port.
    allowedIpCidrs List<String>
    CIDR ranges that every address the host resolves to must fall within.

    Import

    A connection can be imported using its id, e.g.

    $ pulumi import digitalocean:index/actionGatewayConnection:ActionGatewayConnection jira 39f9f768-a7f9-4c91-9557-3328c53dd054

    Import reads scopes and connectionParameters from the API. If the connection was granted more scopes than your configuration lists, or the API stored a connection parameter in a different form, the next plan replaces the connection. Run pulumi preview after importing and update the configuration to match the imported values before you apply.

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

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.85.0
    published on Saturday, Nov 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-digitalocean

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial