Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DevOps
  5. DeployEnvironment
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
pulumi/pulumi-oci

oci.DevOps.DeployEnvironment

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
pulumi/pulumi-oci

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

    Creates a new deployment environment.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDeployEnvironment = new Oci.DevOps.DeployEnvironment("testDeployEnvironment", new()
    {
        DeployEnvironmentType = @var.Deploy_environment_deploy_environment_type,
        ProjectId = oci_devops_project.Test_project.Id,
        ClusterId = oci_containerengine_cluster.Test_cluster.Id,
        ComputeInstanceGroupSelectors = new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsArgs
        {
            Items = new[]
            {
                new Oci.DevOps.Inputs.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs
                {
                    SelectorType = @var.Deploy_environment_compute_instance_group_selectors_items_selector_type,
                    ComputeInstanceIds = @var.Deploy_environment_compute_instance_group_selectors_items_compute_instance_ids,
                    Query = @var.Deploy_environment_compute_instance_group_selectors_items_query,
                    Region = @var.Deploy_environment_compute_instance_group_selectors_items_region,
                },
            },
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = @var.Deploy_environment_description,
        DisplayName = @var.Deploy_environment_display_name,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        FunctionId = oci_functions_function.Test_function.Id,
        NetworkChannel = new Oci.DevOps.Inputs.DeployEnvironmentNetworkChannelArgs
        {
            NetworkChannelType = @var.Deploy_environment_network_channel_network_channel_type,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            NsgIds = @var.Deploy_environment_network_channel_nsg_ids,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DevOps.NewDeployEnvironment(ctx, "testDeployEnvironment", &DevOps.DeployEnvironmentArgs{
			DeployEnvironmentType: pulumi.Any(_var.Deploy_environment_deploy_environment_type),
			ProjectId:             pulumi.Any(oci_devops_project.Test_project.Id),
			ClusterId:             pulumi.Any(oci_containerengine_cluster.Test_cluster.Id),
			ComputeInstanceGroupSelectors: &devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs{
				Items: devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArray{
					&devops.DeployEnvironmentComputeInstanceGroupSelectorsItemArgs{
						SelectorType:       pulumi.Any(_var.Deploy_environment_compute_instance_group_selectors_items_selector_type),
						ComputeInstanceIds: pulumi.Any(_var.Deploy_environment_compute_instance_group_selectors_items_compute_instance_ids),
						Query:              pulumi.Any(_var.Deploy_environment_compute_instance_group_selectors_items_query),
						Region:             pulumi.Any(_var.Deploy_environment_compute_instance_group_selectors_items_region),
					},
				},
			},
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(_var.Deploy_environment_description),
			DisplayName: pulumi.Any(_var.Deploy_environment_display_name),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			FunctionId: pulumi.Any(oci_functions_function.Test_function.Id),
			NetworkChannel: &devops.DeployEnvironmentNetworkChannelArgs{
				NetworkChannelType: pulumi.Any(_var.Deploy_environment_network_channel_network_channel_type),
				SubnetId:           pulumi.Any(oci_core_subnet.Test_subnet.Id),
				NsgIds:             pulumi.Any(_var.Deploy_environment_network_channel_nsg_ids),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(var_.deploy_environment_deploy_environment_type())
            .projectId(oci_devops_project.test_project().id())
            .clusterId(oci_containerengine_cluster.test_cluster().id())
            .computeInstanceGroupSelectors(DeployEnvironmentComputeInstanceGroupSelectorsArgs.builder()
                .items(DeployEnvironmentComputeInstanceGroupSelectorsItemArgs.builder()
                    .selectorType(var_.deploy_environment_compute_instance_group_selectors_items_selector_type())
                    .computeInstanceIds(var_.deploy_environment_compute_instance_group_selectors_items_compute_instance_ids())
                    .query(var_.deploy_environment_compute_instance_group_selectors_items_query())
                    .region(var_.deploy_environment_compute_instance_group_selectors_items_region())
                    .build())
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(var_.deploy_environment_description())
            .displayName(var_.deploy_environment_display_name())
            .freeformTags(Map.of("bar-key", "value"))
            .functionId(oci_functions_function.test_function().id())
            .networkChannel(DeployEnvironmentNetworkChannelArgs.builder()
                .networkChannelType(var_.deploy_environment_network_channel_network_channel_type())
                .subnetId(oci_core_subnet.test_subnet().id())
                .nsgIds(var_.deploy_environment_network_channel_nsg_ids())
                .build())
            .build());

    }
}

    import pulumi
import pulumi_oci as oci

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

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

const testDeployEnvironment = new oci.devops.DeployEnvironment("testDeployEnvironment", {
    deployEnvironmentType: _var.deploy_environment_deploy_environment_type,
    projectId: oci_devops_project.test_project.id,
    clusterId: oci_containerengine_cluster.test_cluster.id,
    computeInstanceGroupSelectors: {
        items: [{
            selectorType: _var.deploy_environment_compute_instance_group_selectors_items_selector_type,
            computeInstanceIds: _var.deploy_environment_compute_instance_group_selectors_items_compute_instance_ids,
            query: _var.deploy_environment_compute_instance_group_selectors_items_query,
            region: _var.deploy_environment_compute_instance_group_selectors_items_region,
        }],
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: _var.deploy_environment_description,
    displayName: _var.deploy_environment_display_name,
    freeformTags: {
        "bar-key": "value",
    },
    functionId: oci_functions_function.test_function.id,
    networkChannel: {
        networkChannelType: _var.deploy_environment_network_channel_network_channel_type,
        subnetId: oci_core_subnet.test_subnet.id,
        nsgIds: _var.deploy_environment_network_channel_nsg_ids,
    },
});

    resources:
  testDeployEnvironment:
    type: oci:DevOps:DeployEnvironment
    properties:
      #Required
      deployEnvironmentType: ${var.deploy_environment_deploy_environment_type}
      projectId: ${oci_devops_project.test_project.id}
      #Optional
      clusterId: ${oci_containerengine_cluster.test_cluster.id}
      computeInstanceGroupSelectors:
        items:
          - selectorType: ${var.deploy_environment_compute_instance_group_selectors_items_selector_type}
            computeInstanceIds: ${var.deploy_environment_compute_instance_group_selectors_items_compute_instance_ids}
            query: ${var.deploy_environment_compute_instance_group_selectors_items_query}
            region: ${var.deploy_environment_compute_instance_group_selectors_items_region}
      definedTags:
        foo-namespace.bar-key: value
      description: ${var.deploy_environment_description}
      displayName: ${var.deploy_environment_display_name}
      freeformTags:
        bar-key: value
      functionId: ${oci_functions_function.test_function.id}
      networkChannel:
        networkChannelType: ${var.deploy_environment_network_channel_network_channel_type}
        subnetId: ${oci_core_subnet.test_subnet.id}
        nsgIds: ${var.deploy_environment_network_channel_nsg_ids}

    Create DeployEnvironment Resource

    new DeployEnvironment(name: string, args: DeployEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def DeployEnvironment(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_id: Optional[str] = None,
                      compute_instance_group_selectors: Optional[_devops.DeployEnvironmentComputeInstanceGroupSelectorsArgs] = None,
                      defined_tags: Optional[Mapping[str, Any]] = None,
                      deploy_environment_type: Optional[str] = None,
                      description: Optional[str] = None,
                      display_name: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, Any]] = None,
                      function_id: Optional[str] = None,
                      network_channel: Optional[_devops.DeployEnvironmentNetworkChannelArgs] = None,
                      project_id: Optional[str] = None)
@overload
def DeployEnvironment(resource_name: str,
                      args: DeployEnvironmentArgs,
                      opts: Optional[ResourceOptions] = 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.
    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.

    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

    The DeployEnvironment resource accepts the following input properties:

    DeployEnvironmentType string

    (Updatable) Deployment environment type.

    ProjectId 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, object>

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

    Description string

    (Updatable) Optional description about the deployment environment.

    DisplayName string

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    FreeformTags Dictionary<string, object>

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

    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 string

    (Updatable) Deployment environment type.

    ProjectId 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]interface{}

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

    Description string

    (Updatable) Optional description about the deployment environment.

    DisplayName string

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    FreeformTags map[string]interface{}

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

    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 String

    (Updatable) Deployment environment type.

    projectId 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,Object>

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

    description String

    (Updatable) Optional description about the deployment environment.

    displayName String

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    freeformTags Map<String,Object>

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

    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 string

    (Updatable) Deployment environment type.

    projectId 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]: any}

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

    description string

    (Updatable) Optional description about the deployment environment.

    displayName string

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    freeformTags {[key: string]: any}

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

    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 str

    (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_group_selectors DeployEnvironmentComputeInstanceGroupSelectorsArgs

    (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.

    defined_tags Mapping[str, Any]

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

    description str

    (Updatable) Optional description about the deployment environment.

    display_name str

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    freeform_tags Mapping[str, Any]

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

    function_id str

    (Updatable) The OCID of the Function.

    network_channel DeployEnvironmentNetworkChannelArgs

    (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network.

    deployEnvironmentType String

    (Updatable) Deployment environment type.

    projectId 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<Any>

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

    description String

    (Updatable) Optional description about the deployment environment.

    displayName String

    (Updatable) Deployment environment display name. Avoid entering confidential information.

    freeformTags Map<Any>

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

    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, object>

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

    TimeCreated string

    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]interface{}

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

    TimeCreated string

    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,Object>

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

    timeCreated String

    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]: any}

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

    timeCreated string

    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, Any]

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

    time_created str

    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<Any>

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

    timeCreated String

    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, Any]] = None,
        deploy_environment_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = 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, Any]] = 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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, object>

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

    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, object>

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

    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 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, object>

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

    TimeCreated string

    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]interface{}

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

    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]interface{}

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

    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 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]interface{}

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

    TimeCreated string

    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,Object>

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

    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,Object>

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

    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 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,Object>

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

    timeCreated String

    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]: any}

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

    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]: any}

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

    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 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]: any}

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

    timeCreated string

    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 DeployEnvironmentComputeInstanceGroupSelectorsArgs

    (Updatable) A collection of selectors. The combination of instances matching the selectors are included in the instance group.

    defined_tags Mapping[str, Any]

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

    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, Any]

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

    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 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 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, Any]

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

    time_created str

    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<Any>

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

    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<Any>

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

    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 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<Any>

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

    timeCreated String

    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 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 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 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 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 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 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 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 string

    (Updatable) Network channel type.

    SubnetId 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 string

    (Updatable) Network channel type.

    SubnetId 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 String

    (Updatable) Network channel type.

    subnetId 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 string

    (Updatable) Network channel type.

    subnetId 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 str

    (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.

    networkChannelType String

    (Updatable) Network channel type.

    subnetId 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"

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the oci Terraform Provider.

    oci logo
    Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
    pulumi/pulumi-oci