Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 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,
},
});
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,
})
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
})
}
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,
},
});
});
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());
}
}
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}
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[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[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 string
- The unique name of the resource.
- args DeployEnvironmentArgs
- 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 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 string
- The unique name of the resource.
- args DeployEnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeployEnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
},
},
});
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"),
},
},
})
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());
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"],
})
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"],
},
});
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
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:
- Deploy
Environment stringType - (Updatable) Deployment environment type.
- Project
Id 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
- Cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- Compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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.
- Display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - Function
Id string - (Updatable) The OCID of the Function.
- Network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Deploy
Environment stringType - (Updatable) Deployment environment type.
- Project
Id 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
- Cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- Compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors Args - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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.
- Display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - Function
Id string - (Updatable) The OCID of the Function.
- Network
Channel DeployEnvironment Network Channel Args - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- deploy
Environment StringType - (Updatable) Deployment environment type.
- project
Id 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
- cluster
Id String - (Updatable) The OCID of the Kubernetes cluster.
- compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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.
- display
Name String - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - function
Id String - (Updatable) The OCID of the Function.
- network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- deploy
Environment stringType - (Updatable) Deployment environment type.
- project
Id 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
- cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- {[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.
- display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- {[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"} - function
Id string - (Updatable) The OCID of the Function.
- network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- deploy_
environment_ strtype - (Updatable) Deployment environment type.
- project_
id 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_ Deploygroup_ selectors Environment Compute Instance Group Selectors Args - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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.
- 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 DeployEnvironment Network Channel Args - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- deploy
Environment StringType - (Updatable) Deployment environment type.
- project
Id 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
- cluster
Id String - (Updatable) The OCID of the Kubernetes cluster.
- compute
Instance Property MapGroup Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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.
- display
Name String - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - function
Id String - (Updatable) The OCID of the Function.
- network
Channel 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:
- Compartment
Id string - The OCID of a compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- 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"} - Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- Compartment
Id string - The OCID of a compartment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- 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"} - Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- compartment
Id String - The OCID of a compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- 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"} - time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated String - Time the deployment environment was updated. Format defined by RFC3339.
- compartment
Id string - The OCID of a compartment.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- {[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"} - time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated 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.
- 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.
- compartment
Id String - The OCID of a compartment.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated 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[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[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) -> DeployEnvironmentfunc 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
- 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.
- Cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- Compartment
Id string - The OCID of a compartment.
- Compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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"} - Deploy
Environment stringType - (Updatable) Deployment environment type.
- Description string
- (Updatable) Optional description about the deployment environment.
- Display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - Function
Id string - (Updatable) The OCID of the Function.
- Lifecycle
Details 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.
- Network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Project
Id 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.
- 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"} - Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- Cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- Compartment
Id string - The OCID of a compartment.
- Compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors Args - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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"} - Deploy
Environment stringType - (Updatable) Deployment environment type.
- Description string
- (Updatable) Optional description about the deployment environment.
- Display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - Function
Id string - (Updatable) The OCID of the Function.
- Lifecycle
Details 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.
- Network
Channel DeployEnvironment Network Channel Args - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- Project
Id 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.
- 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"} - Time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- Time
Updated string - Time the deployment environment was updated. Format defined by RFC3339.
- cluster
Id String - (Updatable) The OCID of the Kubernetes cluster.
- compartment
Id String - The OCID of a compartment.
- compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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"} - deploy
Environment StringType - (Updatable) Deployment environment type.
- description String
- (Updatable) Optional description about the deployment environment.
- display
Name String - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - function
Id String - (Updatable) The OCID of the Function.
- lifecycle
Details 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.
- network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id 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.
- 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"} - time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated String - Time the deployment environment was updated. Format defined by RFC3339.
- cluster
Id string - (Updatable) The OCID of the Kubernetes cluster.
- compartment
Id string - The OCID of a compartment.
- compute
Instance DeployGroup Selectors Environment Compute Instance Group Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- {[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"} - deploy
Environment stringType - (Updatable) Deployment environment type.
- description string
- (Updatable) Optional description about the deployment environment.
- display
Name string - (Updatable) Deployment environment display name. Avoid entering confidential information.
- {[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"} - function
Id string - (Updatable) The OCID of the Function.
- lifecycle
Details 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.
- network
Channel DeployEnvironment Network Channel - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id 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.
- {[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"} - time
Created string - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated 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_ Deploygroup_ selectors Environment Compute Instance Group Selectors Args - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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_ strtype - (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.
- 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 DeployEnvironment Network Channel Args - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project_
id 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.
- 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.
- cluster
Id String - (Updatable) The OCID of the Kubernetes cluster.
- compartment
Id String - The OCID of a compartment.
- compute
Instance Property MapGroup Selectors - (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.
- 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"} - deploy
Environment StringType - (Updatable) Deployment environment type.
- description String
- (Updatable) Optional description about the deployment environment.
- display
Name String - (Updatable) Deployment environment display name. Avoid entering confidential information.
- 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"} - function
Id String - (Updatable) The OCID of the Function.
- lifecycle
Details 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.
- network
Channel Property Map - (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.
- project
Id 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.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - Time the deployment environment was created. Format defined by RFC3339.
- time
Updated String - Time the deployment environment was updated. Format defined by RFC3339.
Supporting Types
DeployEnvironmentComputeInstanceGroupSelectors, DeployEnvironmentComputeInstanceGroupSelectorsArgs
- Items
List<Deploy
Environment Compute Instance Group Selectors Item> - (Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- Items
[]Deploy
Environment Compute Instance Group Selectors Item - (Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
List<Deploy
Environment Compute Instance Group Selectors Item> - (Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
Deploy
Environment Compute Instance Group Selectors Item[] - (Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector.
- items
Sequence[Deploy
Environment Compute Instance Group Selectors Item] - (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
- Selector
Type string - (Updatable) Defines the type of the instance selector for the group.
- Compute
Instance List<string>Ids - (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 string - (Updatable) Defines the type of the instance selector for the group.
- Compute
Instance []stringIds - (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 String - (Updatable) Defines the type of the instance selector for the group.
- compute
Instance List<String>Ids - (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 string - (Updatable) Defines the type of the instance selector for the group.
- compute
Instance string[]Ids - (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 str - (Updatable) Defines the type of the instance selector for the group.
- compute_
instance_ Sequence[str]ids - (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
- selector
Type String - (Updatable) Defines the type of the instance selector for the group.
- compute
Instance List<String>Ids - (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
- Network
Channel stringType - (Updatable) Network channel type.
- Subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- Nsg
Ids List<string> - (Updatable) An array of network security group OCIDs.
- Network
Channel stringType - (Updatable) Network channel type.
- Subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- Nsg
Ids []string - (Updatable) An array of network security group OCIDs.
- network
Channel StringType - (Updatable) Network channel type.
- subnet
Id String - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids List<String> - (Updatable) An array of network security group OCIDs.
- network
Channel stringType - (Updatable) Network channel type.
- subnet
Id string - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids string[] - (Updatable) An array of network security group OCIDs.
- network_
channel_ strtype - (Updatable) Network channel type.
- subnet_
id 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.
- network
Channel StringType - (Updatable) Network channel type.
- subnet
Id String - (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint.
- nsg
Ids 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"
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
ociTerraform Provider.