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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testEnvironment = new oci.cloudbridge.Environment("test_environment", {
compartmentId: compartmentId,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: environmentDisplayName,
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_environment = oci.cloud_bridge.Environment("test_environment",
compartment_id=compartment_id,
defined_tags={
"Operations.CostCenter": "42",
},
display_name=environment_display_name,
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/CloudBridge"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := CloudBridge.NewEnvironment(ctx, "test_environment", &CloudBridge.EnvironmentArgs{
CompartmentId: pulumi.Any(compartmentId),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
DisplayName: pulumi.Any(environmentDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
})
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 testEnvironment = new Oci.CloudBridge.Environment("test_environment", new()
{
CompartmentId = compartmentId,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = environmentDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
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(compartmentId)
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(environmentDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testEnvironment:
type: oci:CloudBridge:Environment
name: test_environment
properties:
compartmentId: ${compartmentId}
definedTags:
Operations.CostCenter: '42'
displayName: ${environmentDisplayName}
freeformTags:
Department: Finance
Create Environment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
args: EnvironmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Environment(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var environmentResource = new Oci.CloudBridge.Environment("environmentResource", new()
{
CompartmentId = "string",
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := CloudBridge.NewEnvironment(ctx, "environmentResource", &CloudBridge.EnvironmentArgs{
CompartmentId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
.compartmentId("string")
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
environment_resource = oci.cloud_bridge.Environment("environmentResource",
compartment_id="string",
defined_tags={
"string": "string",
},
display_name="string",
freeform_tags={
"string": "string",
})
const environmentResource = new oci.cloudbridge.Environment("environmentResource", {
compartmentId: "string",
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:CloudBridge:Environment
properties:
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Environment resource accepts the following input properties:
- Compartment
Id string - (Updatable) Compartment identifier.
- Dictionary<string, string>
- (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 string - (Updatable) Environment identifier.
- Dictionary<string, string>
(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 string - (Updatable) Compartment identifier.
- map[string]string
- (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 string - (Updatable) Environment identifier.
- map[string]string
(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 String - (Updatable) Compartment identifier.
- Map<String,String>
- (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 String - (Updatable) Environment identifier.
- Map<String,String>
(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 string - (Updatable) Compartment identifier.
- {[key: string]: string}
- (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 string - (Updatable) Environment identifier.
- {[key: string]: string}
(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.
- Mapping[str, str]
- (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.
- Mapping[str, str]
(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 String - (Updatable) Compartment identifier.
- Map<String>
- (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 String - (Updatable) Environment identifier.
- Map<String>
(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.
- Lifecycle
Details 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.
- Dictionary<string, string>
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- Time
Updated 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.
- Lifecycle
Details 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.
- map[string]string
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- Time
Updated 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.
- lifecycle
Details 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.
- Map<String,String>
- 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 String - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated 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.
- lifecycle
Details 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.
- {[key: string]: string}
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated 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.
- Mapping[str, str]
- 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.
- lifecycle
Details 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.
- Map<String>
- 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 String - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated 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, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_details: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = 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.
- Compartment
Id string - (Updatable) Compartment identifier.
- Dictionary<string, string>
- (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 string - (Updatable) Environment identifier.
- Dictionary<string, string>
(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 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.
- Dictionary<string, string>
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the source environment was updated. An RFC3339 formatted datetime string.
- Compartment
Id string - (Updatable) Compartment identifier.
- map[string]string
- (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 string - (Updatable) Environment identifier.
- map[string]string
(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 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.
- map[string]string
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the source environment was updated. An RFC3339 formatted datetime string.
- compartment
Id String - (Updatable) Compartment identifier.
- Map<String,String>
- (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 String - (Updatable) Environment identifier.
- Map<String,String>
(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 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.
- Map<String,String>
- 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 String - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated String - The time when the source environment was updated. An RFC3339 formatted datetime string.
- compartment
Id string - (Updatable) Compartment identifier.
- {[key: string]: string}
- (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 string - (Updatable) Environment identifier.
- {[key: string]: string}
(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 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.
- {[key: string]: string}
- 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 string - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated string - The time when the source environment was updated. An RFC3339 formatted datetime string.
- compartment_
id str - (Updatable) Compartment identifier.
- Mapping[str, str]
- (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.
- Mapping[str, str]
(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.
- Mapping[str, str]
- 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.
- compartment
Id String - (Updatable) Compartment identifier.
- Map<String>
- (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 String - (Updatable) Environment identifier.
- Map<String>
(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 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.
- Map<String>
- 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 String - The time when the source environment was created. An RFC3339 formatted datetime string.
- time
Updated 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"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.