Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Connection

This resource provides the Connection resource in Oracle Cloud Infrastructure Devops service.

Creates a new connection.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testConnection = new Oci.DevOps.Connection("testConnection", new Oci.DevOps.ConnectionArgs
        {
            AccessToken = @var.Connection_access_token,
            ConnectionType = @var.Connection_connection_type,
            ProjectId = oci_devops_project.Test_project.Id,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = @var.Connection_description,
            DisplayName = @var.Connection_display_name,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DevOps"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DevOps.NewConnection(ctx, "testConnection", &DevOps.ConnectionArgs{
			AccessToken:    pulumi.Any(_var.Connection_access_token),
			ConnectionType: pulumi.Any(_var.Connection_connection_type),
			ProjectId:      pulumi.Any(oci_devops_project.Test_project.Id),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(_var.Connection_description),
			DisplayName: pulumi.Any(_var.Connection_display_name),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_connection = oci.dev_ops.Connection("testConnection",
    access_token=var["connection_access_token"],
    connection_type=var["connection_connection_type"],
    project_id=oci_devops_project["test_project"]["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=var["connection_description"],
    display_name=var["connection_display_name"],
    freeform_tags={
        "bar-key": "value",
    })
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConnection = new oci.devops.Connection("testConnection", {
    accessToken: _var.connection_access_token,
    connectionType: _var.connection_connection_type,
    projectId: oci_devops_project.test_project.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: _var.connection_description,
    displayName: _var.connection_display_name,
    freeformTags: {
        "bar-key": "value",
    },
});

Coming soon!

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_token: Optional[str] = None,
               connection_type: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               project_id: Optional[str] = None)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = 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: oci:DevOps:Connection
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Connection resource accepts the following input properties:

AccessToken string

(Updatable) The OCID of personal access token saved in secret store.

ConnectionType string

(Updatable) The type of connection.

ProjectId string

The OCID of the DevOps project.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) Optional description about the connection.

DisplayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

AccessToken string

(Updatable) The OCID of personal access token saved in secret store.

ConnectionType string

(Updatable) The type of connection.

ProjectId string

The OCID of the DevOps project.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) Optional description about the connection.

DisplayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

accessToken String

(Updatable) The OCID of personal access token saved in secret store.

connectionType String

(Updatable) The type of connection.

projectId String

The OCID of the DevOps project.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) Optional description about the connection.

displayName String

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

accessToken string

(Updatable) The OCID of personal access token saved in secret store.

connectionType string

(Updatable) The type of connection.

projectId string

The OCID of the DevOps project.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) Optional description about the connection.

displayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

access_token str

(Updatable) The OCID of personal access token saved in secret store.

connection_type str

(Updatable) The type of connection.

project_id str

The OCID of the DevOps project.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) Optional description about the connection.

display_name str

(Updatable) Optional connection display name. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

accessToken String

(Updatable) The OCID of personal access token saved in secret store.

connectionType String

(Updatable) The type of connection.

projectId String

The OCID of the DevOps project.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) Optional description about the connection.

displayName String

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

Outputs

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

CompartmentId string

The OCID of the compartment containing the connection.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the connection.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the connection was created. Format defined by RFC3339.

TimeUpdated string

The time the connection was updated. Format defined by RFC3339.

CompartmentId string

The OCID of the compartment containing the connection.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the connection.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the connection was created. Format defined by RFC3339.

TimeUpdated string

The time the connection was updated. Format defined by RFC3339.

compartmentId String

The OCID of the compartment containing the connection.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the connection.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the connection was created. Format defined by RFC3339.

timeUpdated String

The time the connection was updated. Format defined by RFC3339.

compartmentId string

The OCID of the compartment containing the connection.

id string

The provider-assigned unique ID for this managed resource.

state string

The current state of the connection.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The time the connection was created. Format defined by RFC3339.

timeUpdated string

The time the connection was updated. Format defined by RFC3339.

compartment_id str

The OCID of the compartment containing the connection.

id str

The provider-assigned unique ID for this managed resource.

state str

The current state of the connection.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The time the connection was created. Format defined by RFC3339.

time_updated str

The time the connection was updated. Format defined by RFC3339.

compartmentId String

The OCID of the compartment containing the connection.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the connection.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the connection was created. Format defined by RFC3339.

timeUpdated String

The time the connection was updated. Format defined by RFC3339.

Look up an 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,
        access_token: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        project_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: 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:
AccessToken string

(Updatable) The OCID of personal access token saved in secret store.

CompartmentId string

The OCID of the compartment containing the connection.

ConnectionType string

(Updatable) The type of connection.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) Optional description about the connection.

DisplayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

ProjectId string

The OCID of the DevOps project.

State string

The current state of the connection.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the connection was created. Format defined by RFC3339.

TimeUpdated string

The time the connection was updated. Format defined by RFC3339.

AccessToken string

(Updatable) The OCID of personal access token saved in secret store.

CompartmentId string

The OCID of the compartment containing the connection.

ConnectionType string

(Updatable) The type of connection.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

Description string

(Updatable) Optional description about the connection.

DisplayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

ProjectId string

The OCID of the DevOps project.

State string

The current state of the connection.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The time the connection was created. Format defined by RFC3339.

TimeUpdated string

The time the connection was updated. Format defined by RFC3339.

accessToken String

(Updatable) The OCID of personal access token saved in secret store.

compartmentId String

The OCID of the compartment containing the connection.

connectionType String

(Updatable) The type of connection.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) Optional description about the connection.

displayName String

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

projectId String

The OCID of the DevOps project.

state String

The current state of the connection.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the connection was created. Format defined by RFC3339.

timeUpdated String

The time the connection was updated. Format defined by RFC3339.

accessToken string

(Updatable) The OCID of personal access token saved in secret store.

compartmentId string

The OCID of the compartment containing the connection.

connectionType string

(Updatable) The type of connection.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description string

(Updatable) Optional description about the connection.

displayName string

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

projectId string

The OCID of the DevOps project.

state string

The current state of the connection.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The time the connection was created. Format defined by RFC3339.

timeUpdated string

The time the connection was updated. Format defined by RFC3339.

access_token str

(Updatable) The OCID of personal access token saved in secret store.

compartment_id str

The OCID of the compartment containing the connection.

connection_type str

(Updatable) The type of connection.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description str

(Updatable) Optional description about the connection.

display_name str

(Updatable) Optional connection display name. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

project_id str

The OCID of the DevOps project.

state str

The current state of the connection.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The time the connection was created. Format defined by RFC3339.

time_updated str

The time the connection was updated. Format defined by RFC3339.

accessToken String

(Updatable) The OCID of personal access token saved in secret store.

compartmentId String

The OCID of the compartment containing the connection.

connectionType String

(Updatable) The type of connection.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}

description String

(Updatable) Optional description about the connection.

displayName String

(Updatable) Optional connection display name. Avoid entering confidential information.

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

projectId String

The OCID of the DevOps project.

state String

The current state of the connection.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The time the connection was created. Format defined by RFC3339.

timeUpdated String

The time the connection was updated. Format defined by RFC3339.

Import

Connections can be imported using the id, e.g.

 $ pulumi import oci:DevOps/connection:Connection test_connection "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.