1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DevOps
  5. DeployEnvironment
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DevOps.DeployEnvironment

Explore with Pulumi AI

This resource provides the Deploy Environment resource in Oracle Cloud Infrastructure Devops service.

Creates a new deployment environment.

Example Usage

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

const testDeployEnvironment = new oci.devops.DeployEnvironment("test_deploy_environment", {
    deployEnvironmentType: deployEnvironmentDeployEnvironmentType,
    projectId: testProject.id,
    clusterId: testCluster.id,
    computeInstanceGroupSelectors: {
        items: [{
            selectorType: deployEnvironmentComputeInstanceGroupSelectorsItemsSelectorType,
            computeInstanceIds: deployEnvironmentComputeInstanceGroupSelectorsItemsComputeInstanceIds,
            query: deployEnvironmentComputeInstanceGroupSelectorsItemsQuery,
            region: deployEnvironmentComputeInstanceGroupSelectorsItemsRegion,
        }],
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: deployEnvironmentDescription,
    displayName: deployEnvironmentDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
    functionId: testFunction.id,
    networkChannel: {
        networkChannelType: deployEnvironmentNetworkChannelNetworkChannelType,
        subnetId: testSubnet.id,
        nsgIds: deployEnvironmentNetworkChannelNsgIds,
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_deploy_environment = oci.dev_ops.DeployEnvironment("test_deploy_environment",
    deploy_environment_type=deploy_environment_deploy_environment_type,
    project_id=test_project["id"],
    cluster_id=test_cluster["id"],
    compute_instance_group_selectors={
        "items": [{
            "selector_type": deploy_environment_compute_instance_group_selectors_items_selector_type,
            "compute_instance_ids": deploy_environment_compute_instance_group_selectors_items_compute_instance_ids,
            "query": deploy_environment_compute_instance_group_selectors_items_query,
            "region": deploy_environment_compute_instance_group_selectors_items_region,
        }],
    },
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=deploy_environment_description,
    display_name=deploy_environment_display_name,
    freeform_tags={
        "bar-key": "value",
    },
    function_id=test_function["id"],
    network_channel={
        "network_channel_type": deploy_environment_network_channel_network_channel_type,
        "subnet_id": test_subnet["id"],
        "nsg_ids": deploy_environment_network_channel_nsg_ids,
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devops.NewDeployEnvironment(ctx, "test_deploy_environment", &devops.DeployEnvironmentArgs{
			DeployEnvironmentType: pulumi.Any(deployEnvironmentDeployEnvironmentType),
			ProjectId:             pulumi.Any(testProject.Id),
			ClusterId:             pulumi.Any(testCluster.Id),
			ComputeInstanceGroupSelectors: &devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs{
				Items: devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArray{
					&devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs{
						SelectorType:       pulumi.Any(deployEnvironmentComputeInstanceGroupSelectorsItemsSelectorType),
						ComputeInstanceIds: pulumi.Any(deployEnvironmentComputeInstanceGroupSelectorsItemsComputeInstanceIds),
						Query:              pulumi.Any(deployEnvironmentComputeInstanceGroupSelectorsItemsQuery),
						Region:             pulumi.Any(deployEnvironmentComputeInstanceGroupSelectorsItemsRegion),
					},
				},
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(deployEnvironmentDescription),
			DisplayName: pulumi.Any(deployEnvironmentDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			FunctionId: pulumi.Any(testFunction.Id),
			NetworkChannel: &devops.DeployEnvironmentNetworkChannelArgs{
				NetworkChannelType: pulumi.Any(deployEnvironmentNetworkChannelNetworkChannelType),
				SubnetId:           pulumi.Any(testSubnet.Id),
				NsgIds:             pulumi.Any(deployEnvironmentNetworkChannelNsgIds),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeployEnvironment = new Oci.DevOps.DeployEnvironment("test_deploy_environment", new()
    {
        DeployEnvironmentType = deployEnvironmentDeployEnvironmentType,
        ProjectId = testProject.Id,
        ClusterId = testCluster.Id,
        ComputeInstanceGroupSelectors = new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsArgs
        {
            Items = new[]
            {
                new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs
                {
                    SelectorType = deployEnvironmentComputeInstanceGroupSelectorsItemsSelectorType,
                    ComputeInstanceIds = deployEnvironmentComputeInstanceGroupSelectorsItemsComputeInstanceIds,
                    Query = deployEnvironmentComputeInstanceGroupSelectorsItemsQuery,
                    Region = deployEnvironmentComputeInstanceGroupSelectorsItemsRegion,
                },
            },
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = deployEnvironmentDescription,
        DisplayName = deployEnvironmentDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        FunctionId = testFunction.Id,
        NetworkChannel = new Oci.DevOps.Inputs.DeployEnvironmentNetworkChannelArgs
        {
            NetworkChannelType = deployEnvironmentNetworkChannelNetworkChannelType,
            SubnetId = testSubnet.Id,
            NsgIds = deployEnvironmentNetworkChannelNsgIds,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DevOps.DeployEnvironment;
import com.pulumi.oci.DevOps.DeployEnvironmentArgs;
import com.pulumi.oci.DevOps.inputs.DeployEnvironmentComputeInstanceGroupSelectorsArgs;
import com.pulumi.oci.DevOps.inputs.DeployEnvironmentNetworkChannelArgs;
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 testDeployEnvironment = new DeployEnvironment("testDeployEnvironment", DeployEnvironmentArgs.builder()
            .deployEnvironmentType(deployEnvironmentDeployEnvironmentType)
            .projectId(testProject.id())
            .clusterId(testCluster.id())
            .computeInstanceGroupSelectors(DeployEnvironmentComputeInstanceGroupSelectorsArgs.builder()
                .items(DeployEnvironmentComputeInstanceGroupSelectorsItemArgs.builder()
                    .selectorType(deployEnvironmentComputeInstanceGroupSelectorsItemsSelectorType)
                    .computeInstanceIds(deployEnvironmentComputeInstanceGroupSelectorsItemsComputeInstanceIds)
                    .query(deployEnvironmentComputeInstanceGroupSelectorsItemsQuery)
                    .region(deployEnvironmentComputeInstanceGroupSelectorsItemsRegion)
                    .build())
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(deployEnvironmentDescription)
            .displayName(deployEnvironmentDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .functionId(testFunction.id())
            .networkChannel(DeployEnvironmentNetworkChannelArgs.builder()
                .networkChannelType(deployEnvironmentNetworkChannelNetworkChannelType)
                .subnetId(testSubnet.id())
                .nsgIds(deployEnvironmentNetworkChannelNsgIds)
                .build())
            .build());

    }
}
Copy
resources:
  testDeployEnvironment:
    type: oci:DevOps:DeployEnvironment
    name: test_deploy_environment
    properties:
      deployEnvironmentType: ${deployEnvironmentDeployEnvironmentType}
      projectId: ${testProject.id}
      clusterId: ${testCluster.id}
      computeInstanceGroupSelectors:
        items:
          - selectorType: ${deployEnvironmentComputeInstanceGroupSelectorsItemsSelectorType}
            computeInstanceIds: ${deployEnvironmentComputeInstanceGroupSelectorsItemsComputeInstanceIds}
            query: ${deployEnvironmentComputeInstanceGroupSelectorsItemsQuery}
            region: ${deployEnvironmentComputeInstanceGroupSelectorsItemsRegion}
      definedTags:
        foo-namespace.bar-key: value
      description: ${deployEnvironmentDescription}
      displayName: ${deployEnvironmentDisplayName}
      freeformTags:
        bar-key: value
      functionId: ${testFunction.id}
      networkChannel:
        networkChannelType: ${deployEnvironmentNetworkChannelNetworkChannelType}
        subnetId: ${testSubnet.id}
        nsgIds: ${deployEnvironmentNetworkChannelNsgIds}
Copy

Create DeployEnvironment Resource

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

Constructor syntax

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

@overload
def DeployEnvironment(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      deploy_environment_type: Optional[str] = None,
                      project_id: Optional[str] = None,
                      cluster_id: Optional[str] = None,
                      compute_instance_group_selectors: Optional[_devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      description: Optional[str] = None,
                      display_name: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      function_id: Optional[str] = None,
                      network_channel: Optional[_devops.DeployEnvironmentNetworkChannelArgs] = None)
func NewDeployEnvironment(ctx *Context, name string, args DeployEnvironmentArgs, opts ...ResourceOption) (*DeployEnvironment, error)
public DeployEnvironment(string name, DeployEnvironmentArgs args, CustomResourceOptions? opts = null)
public DeployEnvironment(String name, DeployEnvironmentArgs args)
public DeployEnvironment(String name, DeployEnvironmentArgs args, CustomResourceOptions options)
type: oci:DevOps:DeployEnvironment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DeployEnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DeployEnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DeployEnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeployEnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeployEnvironmentArgs
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 deployEnvironmentResource = new Oci.DevOps.DeployEnvironment("deployEnvironmentResource", new()
{
    DeployEnvironmentType = "string",
    ProjectId = "string",
    ClusterId = "string",
    ComputeInstanceGroupSelectors = new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsArgs
    {
        Items = new[]
        {
            new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs
            {
                SelectorType = "string",
                ComputeInstanceIds = new[]
                {
                    "string",
                },
                Query = "string",
                Region = "string",
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    FunctionId = "string",
    NetworkChannel = new Oci.DevOps.Inputs.DeployEnvironmentNetworkChannelArgs
    {
        NetworkChannelType = "string",
        SubnetId = "string",
        NsgIds = new[]
        {
            "string",
        },
    },
});
Copy
example, err := DevOps.NewDeployEnvironment(ctx, "deployEnvironmentResource", &DevOps.DeployEnvironmentArgs{
	DeployEnvironmentType: pulumi.String("string"),
	ProjectId:             pulumi.String("string"),
	ClusterId:             pulumi.String("string"),
	ComputeInstanceGroupSelectors: &devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs{
		Items: devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArray{
			&devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs{
				SelectorType: pulumi.String("string"),
				ComputeInstanceIds: pulumi.StringArray{
					pulumi.String("string"),
				},
				Query:  pulumi.String("string"),
				Region: pulumi.String("string"),
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FunctionId: pulumi.String("string"),
	NetworkChannel: &devops.DeployEnvironmentNetworkChannelArgs{
		NetworkChannelType: pulumi.String("string"),
		SubnetId:           pulumi.String("string"),
		NsgIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})
Copy
var deployEnvironmentResource = new DeployEnvironment("deployEnvironmentResource", DeployEnvironmentArgs.builder()
    .deployEnvironmentType("string")
    .projectId("string")
    .clusterId("string")
    .computeInstanceGroupSelectors(DeployEnvironmentComputeInstanceGroupSelectorsArgs.builder()
        .items(DeployEnvironmentComputeInstanceGroupSelectorsItemArgs.builder()
            .selectorType("string")
            .computeInstanceIds("string")
            .query("string")
            .region("string")
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .functionId("string")
    .networkChannel(DeployEnvironmentNetworkChannelArgs.builder()
        .networkChannelType("string")
        .subnetId("string")
        .nsgIds("string")
        .build())
    .build());
Copy
deploy_environment_resource = oci.dev_ops.DeployEnvironment("deployEnvironmentResource",
    deploy_environment_type="string",
    project_id="string",
    cluster_id="string",
    compute_instance_group_selectors={
        "items": [{
            "selector_type": "string",
            "compute_instance_ids": ["string"],
            "query": "string",
            "region": "string",
        }],
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    function_id="string",
    network_channel={
        "network_channel_type": "string",
        "subnet_id": "string",
        "nsg_ids": ["string"],
    })
Copy
const deployEnvironmentResource = new oci.devops.DeployEnvironment("deployEnvironmentResource", {
    deployEnvironmentType: "string",
    projectId: "string",
    clusterId: "string",
    computeInstanceGroupSelectors: {
        items: [{
            selectorType: "string",
            computeInstanceIds: ["string"],
            query: "string",
            region: "string",
        }],
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    functionId: "string",
    networkChannel: {
        networkChannelType: "string",
        subnetId: "string",
        nsgIds: ["string"],
    },
});
Copy
type: oci:DevOps:DeployEnvironment
properties:
    clusterId: string
    computeInstanceGroupSelectors:
        items:
            - computeInstanceIds:
                - string
              query: string
              region: string
              selectorType: string
    definedTags:
        string: string
    deployEnvironmentType: string
    description: string
    displayName: string
    freeformTags:
        string: string
    functionId: string
    networkChannel:
        networkChannelType: string
        nsgIds:
            - string
        subnetId: string
    projectId: string
Copy

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

DeployEnvironmentType This property is required. string
(Updatable) Deployment environment type.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ClusterId string
(Updatable) The OCID of the Kubernetes cluster.
ComputeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
DefinedTags Dictionary<string, string>
(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 deployment environment.
DisplayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(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"}
FunctionId string
(Updatable) The OCID of the Function.
NetworkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
DeployEnvironmentType This property is required. string
(Updatable) Deployment environment type.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ClusterId string
(Updatable) The OCID of the Kubernetes cluster.
ComputeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectorsArgs
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
DefinedTags map[string]string
(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 deployment environment.
DisplayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
FreeformTags map[string]string
(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"}
FunctionId string
(Updatable) The OCID of the Function.
NetworkChannel DeployEnvironmentNetworkChannelArgs
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
deployEnvironmentType This property is required. String
(Updatable) Deployment environment type.
projectId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterId String
(Updatable) The OCID of the Kubernetes cluster.
computeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags Map<String,String>
(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 deployment environment.
displayName String
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags Map<String,String>
(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"}
functionId String
(Updatable) The OCID of the Function.
networkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
deployEnvironmentType This property is required. string
(Updatable) Deployment environment type.
projectId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterId string
(Updatable) The OCID of the Kubernetes cluster.
computeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags {[key: string]: string}
(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 deployment environment.
displayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags {[key: string]: string}
(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"}
functionId string
(Updatable) The OCID of the Function.
networkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
deploy_environment_type This property is required. str
(Updatable) Deployment environment type.
project_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

cluster_id str
(Updatable) The OCID of the Kubernetes cluster.
compute_instance_group_selectors devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
defined_tags Mapping[str, str]
(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 deployment environment.
display_name str
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(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"}
function_id str
(Updatable) The OCID of the Function.
network_channel devops.DeployEnvironmentNetworkChannelArgs
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
deployEnvironmentType This property is required. String
(Updatable) Deployment environment type.
projectId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterId String
(Updatable) The OCID of the Kubernetes cluster.
computeInstanceGroupSelectors Property Map
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags Map<String>
(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 deployment environment.
displayName String
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags Map<String>
(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"}
functionId String
(Updatable) The OCID of the Function.
networkChannel Property Map
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

Outputs

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

CompartmentId string
The OCID of a compartment.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string
The current state of the deployment environment.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
CompartmentId string
The OCID of a compartment.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string
The current state of the deployment environment.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
compartmentId String
The OCID of a compartment.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String
The current state of the deployment environment.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String
Time the deployment environment was updated. Format defined by RFC3339.
compartmentId string
The OCID of a compartment.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state string
The current state of the deployment environment.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
compartment_id str
The OCID of a compartment.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state str
The current state of the deployment environment.
system_tags Mapping[str, str]
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
Time the deployment environment was created. Format defined by RFC3339.
time_updated str
Time the deployment environment was updated. Format defined by RFC3339.
compartmentId String
The OCID of a compartment.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String
The current state of the deployment environment.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String
Time the deployment environment was updated. Format defined by RFC3339.

Look up Existing DeployEnvironment Resource

Get an existing DeployEnvironment 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?: DeployEnvironmentState, opts?: CustomResourceOptions): DeployEnvironment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        compute_instance_group_selectors: Optional[_devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        deploy_environment_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        function_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        network_channel: Optional[_devops.DeployEnvironmentNetworkChannelArgs] = None,
        project_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> DeployEnvironment
func GetDeployEnvironment(ctx *Context, name string, id IDInput, state *DeployEnvironmentState, opts ...ResourceOption) (*DeployEnvironment, error)
public static DeployEnvironment Get(string name, Input<string> id, DeployEnvironmentState? state, CustomResourceOptions? opts = null)
public static DeployEnvironment get(String name, Output<String> id, DeployEnvironmentState state, CustomResourceOptions options)
resources:  _:    type: oci:DevOps:DeployEnvironment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClusterId string
(Updatable) The OCID of the Kubernetes cluster.
CompartmentId string
The OCID of a compartment.
ComputeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployEnvironmentType string
(Updatable) Deployment environment type.
Description string
(Updatable) Optional description about the deployment environment.
DisplayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(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"}
FunctionId string
(Updatable) The OCID of the Function.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
NetworkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ProjectId Changes to this property will trigger replacement. string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The current state of the deployment environment.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
ClusterId string
(Updatable) The OCID of the Kubernetes cluster.
CompartmentId string
The OCID of a compartment.
ComputeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectorsArgs
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
DeployEnvironmentType string
(Updatable) Deployment environment type.
Description string
(Updatable) Optional description about the deployment environment.
DisplayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
FreeformTags map[string]string
(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"}
FunctionId string
(Updatable) The OCID of the Function.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
NetworkChannel DeployEnvironmentNetworkChannelArgs
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
ProjectId Changes to this property will trigger replacement. string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The current state of the deployment environment.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Time the deployment environment was created. Format defined by RFC3339.
TimeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
clusterId String
(Updatable) The OCID of the Kubernetes cluster.
compartmentId String
The OCID of a compartment.
computeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployEnvironmentType String
(Updatable) Deployment environment type.
description String
(Updatable) Optional description about the deployment environment.
displayName String
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags Map<String,String>
(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"}
functionId String
(Updatable) The OCID of the Function.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
networkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId Changes to this property will trigger replacement. String

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The current state of the deployment environment.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String
Time the deployment environment was updated. Format defined by RFC3339.
clusterId string
(Updatable) The OCID of the Kubernetes cluster.
compartmentId string
The OCID of a compartment.
computeInstanceGroupSelectors DeployEnvironmentComputeInstanceGroupSelectors
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployEnvironmentType string
(Updatable) Deployment environment type.
description string
(Updatable) Optional description about the deployment environment.
displayName string
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags {[key: string]: string}
(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"}
functionId string
(Updatable) The OCID of the Function.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
networkChannel DeployEnvironmentNetworkChannel
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId Changes to this property will trigger replacement. string

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state string
The current state of the deployment environment.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated string
Time the deployment environment was updated. Format defined by RFC3339.
cluster_id str
(Updatable) The OCID of the Kubernetes cluster.
compartment_id str
The OCID of a compartment.
compute_instance_group_selectors devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deploy_environment_type str
(Updatable) Deployment environment type.
description str
(Updatable) Optional description about the deployment environment.
display_name str
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(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"}
function_id str
(Updatable) The OCID of the Function.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
network_channel devops.DeployEnvironmentNetworkChannelArgs
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
project_id Changes to this property will trigger replacement. str

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state str
The current state of the deployment environment.
system_tags Mapping[str, str]
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
Time the deployment environment was created. Format defined by RFC3339.
time_updated str
Time the deployment environment was updated. Format defined by RFC3339.
clusterId String
(Updatable) The OCID of the Kubernetes cluster.
compartmentId String
The OCID of a compartment.
computeInstanceGroupSelectors Property Map
(Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
deployEnvironmentType String
(Updatable) Deployment environment type.
description String
(Updatable) Optional description about the deployment environment.
displayName String
(Updatable) Deployment environment display name. Avoid entering confidential information.
freeformTags Map<String>
(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"}
functionId String
(Updatable) The OCID of the Function.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
networkChannel Property Map
(Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
projectId Changes to this property will trigger replacement. String

The OCID of a project.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The current state of the deployment environment.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Time the deployment environment was created. Format defined by RFC3339.
timeUpdated String
Time the deployment environment was updated. Format defined by RFC3339.

Supporting Types

DeployEnvironmentComputeInstanceGroupSelectors
, DeployEnvironmentComputeInstanceGroupSelectorsArgs

Items List<DeployEnvironmentComputeInstanceGroupSelectorsItem>
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
Items []DeployEnvironmentComputeInstanceGroupSelectorsItem
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
items List<DeployEnvironmentComputeInstanceGroupSelectorsItem>
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
items DeployEnvironmentComputeInstanceGroupSelectorsItem[]
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
items Sequence[devops.DeployEnvironmentComputeInstanceGroupSelectorsItem]
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
items List<Property Map>
(Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.

DeployEnvironmentComputeInstanceGroupSelectorsItem
, DeployEnvironmentComputeInstanceGroupSelectorsItemArgs

SelectorType This property is required. string
(Updatable) Defines the type of the instance selector for the group.
ComputeInstanceIds List<string>
(Updatable) Compute instance OCID identifiers that are members of this group.
Query string
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
Region string
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
SelectorType This property is required. string
(Updatable) Defines the type of the instance selector for the group.
ComputeInstanceIds []string
(Updatable) Compute instance OCID identifiers that are members of this group.
Query string
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
Region string
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType This property is required. String
(Updatable) Defines the type of the instance selector for the group.
computeInstanceIds List<String>
(Updatable) Compute instance OCID identifiers that are members of this group.
query String
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region String
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType This property is required. string
(Updatable) Defines the type of the instance selector for the group.
computeInstanceIds string[]
(Updatable) Compute instance OCID identifiers that are members of this group.
query string
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region string
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selector_type This property is required. str
(Updatable) Defines the type of the instance selector for the group.
compute_instance_ids Sequence[str]
(Updatable) Compute instance OCID identifiers that are members of this group.
query str
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region str
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
selectorType This property is required. String
(Updatable) Defines the type of the instance selector for the group.
computeInstanceIds List<String>
(Updatable) Compute instance OCID identifiers that are members of this group.
query String
(Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm
region String
(Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm

DeployEnvironmentNetworkChannel
, DeployEnvironmentNetworkChannelArgs

NetworkChannelType This property is required. string
(Updatable) Network channel type.
SubnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
NsgIds List<string>
(Updatable) An array of network security group OCIDs.
NetworkChannelType This property is required. string
(Updatable) Network channel type.
SubnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
NsgIds []string
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. String
(Updatable) Network channel type.
subnetId This property is required. String
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds List<String>
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. string
(Updatable) Network channel type.
subnetId This property is required. string
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds string[]
(Updatable) An array of network security group OCIDs.
network_channel_type This property is required. str
(Updatable) Network channel type.
subnet_id This property is required. str
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsg_ids Sequence[str]
(Updatable) An array of network security group OCIDs.
networkChannelType This property is required. String
(Updatable) Network channel type.
subnetId This property is required. String
(Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
nsgIds List<String>
(Updatable) An array of network security group OCIDs.

Import

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

$ pulumi import oci:DevOps/deployEnvironment:DeployEnvironment test_deploy_environment "id"
Copy

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.