Docs Packages
  1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudBridge
  5. Environment
oci logo
Oracle Cloud Infrastructure v0.19.0, May 26 23

oci.CloudBridge.Environment

Explore with Pulumi AI

This resource provides the Environment resource in Oracle Cloud Infrastructure Cloud Bridge service.

Creates a source environment.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testEnvironment = new Oci.CloudBridge.Environment("testEnvironment", new()
    {
        CompartmentId = @var.Compartment_id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Environment_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := CloudBridge.NewEnvironment(ctx, "testEnvironment", &CloudBridge.EnvironmentArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Environment_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
		})
		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.CloudBridge.Environment;
import com.pulumi.oci.CloudBridge.EnvironmentArgs;
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 testEnvironment = new Environment("testEnvironment", EnvironmentArgs.builder()        
            .compartmentId(var_.compartment_id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.environment_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_environment = oci.cloud_bridge.Environment("testEnvironment",
    compartment_id=var["compartment_id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["environment_display_name"],
    freeform_tags={
        "Department": "Finance",
    })

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

const testEnvironment = new oci.cloudbridge.Environment("testEnvironment", {
    compartmentId: _var.compartment_id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.environment_display_name,
    freeformTags: {
        Department: "Finance",
    },
});

resources:
  testEnvironment:
    type: oci:CloudBridge:Environment
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.environment_display_name}
      freeformTags:
        Department: Finance

Create Environment Resource

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None)
@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: oci:CloudBridge:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentArgs
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 EnvironmentArgs
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 EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

CompartmentId string

(Updatable) Compartment identifier.

DefinedTags Dictionary<string, object>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) Environment identifier.

FreeformTags Dictionary<string, object>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

CompartmentId string

(Updatable) Compartment identifier.

DefinedTags map[string]interface{}

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) Environment identifier.

FreeformTags map[string]interface{}

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<String,Object>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) Environment identifier.

freeformTags Map<String,Object>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

compartmentId string

(Updatable) Compartment identifier.

definedTags {[key: string]: any}

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) Environment identifier.

freeformTags {[key: string]: any}

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

compartment_id str

(Updatable) Compartment identifier.

defined_tags Mapping[str, Any]

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) Environment identifier.

freeform_tags Mapping[str, Any]

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<Any>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) Environment identifier.

freeformTags Map<Any>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

State string

The current state of the source environment.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

State string

The current state of the source environment.

SystemTags map[string]interface{}

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state String

The current state of the source environment.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the source environment was updated. An RFC3339 formatted datetime string.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state string

The current state of the source environment.

systemTags {[key: string]: any}

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

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, it can be used to provide actionable information for a resource in Failed state.

state str

The current state of the source environment.

system_tags Mapping[str, Any]

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

time_created str

The time when the source environment was created. An RFC3339 formatted datetime string.

time_updated str

The time when the source environment was updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state String

The current state of the source environment.

systemTags Map<Any>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the source environment was updated. An RFC3339 formatted datetime string.

Look up Existing Environment Resource

Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState 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:
CompartmentId string

(Updatable) Compartment identifier.

DefinedTags Dictionary<string, object>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) Environment identifier.

FreeformTags Dictionary<string, object>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

State string

The current state of the source environment.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

CompartmentId string

(Updatable) Compartment identifier.

DefinedTags map[string]interface{}

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) Environment identifier.

FreeformTags map[string]interface{}

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

State string

The current state of the source environment.

SystemTags map[string]interface{}

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<String,Object>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) Environment identifier.

freeformTags Map<String,Object>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state String

The current state of the source environment.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the source environment was updated. An RFC3339 formatted datetime string.

compartmentId string

(Updatable) Compartment identifier.

definedTags {[key: string]: any}

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) Environment identifier.

freeformTags {[key: string]: any}

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

lifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state string

The current state of the source environment.

systemTags {[key: string]: any}

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated string

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when the source environment was updated. An RFC3339 formatted datetime string.

compartment_id str

(Updatable) Compartment identifier.

defined_tags Mapping[str, Any]

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) Environment identifier.

freeform_tags Mapping[str, Any]

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

lifecycle_details str

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state str

The current state of the source environment.

system_tags Mapping[str, Any]

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

time_created str

The time when the source environment was created. An RFC3339 formatted datetime string.

time_updated str

The time when the source environment was updated. An RFC3339 formatted datetime string.

compartmentId String

(Updatable) Compartment identifier.

definedTags Map<Any>

(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) Environment identifier.

freeformTags Map<Any>

(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

state String

The current state of the source environment.

systemTags Map<Any>

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time when the source environment was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the source environment was updated. An RFC3339 formatted datetime string.

Import

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

 $ pulumi import oci:CloudBridge/environment:Environment test_environment "id"

Package Details

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

This Pulumi package is based on the oci Terraform Provider.