Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. TagDefault
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Identity.TagDefault

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Tag Default resource in Oracle Cloud Infrastructure Identity service.

Creates a new tag default in the specified compartment for the specified tag definition.

If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to “true”, the value is set during resource creation.
  • If the isRequired flag is set to “false”, the value you enter is set during resource creation.

Example Usage

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

const testTagDefault = new oci.identity.TagDefault("test_tag_default", {
    compartmentId: compartmentId,
    tagDefinitionId: testTagDefinition.id,
    value: tagDefaultValue,
    isRequired: tagDefaultIsRequired,
});
Copy
import pulumi
import pulumi_oci as oci

test_tag_default = oci.identity.TagDefault("test_tag_default",
    compartment_id=compartment_id,
    tag_definition_id=test_tag_definition["id"],
    value=tag_default_value,
    is_required=tag_default_is_required)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.NewTagDefault(ctx, "test_tag_default", &identity.TagDefaultArgs{
			CompartmentId:   pulumi.Any(compartmentId),
			TagDefinitionId: pulumi.Any(testTagDefinition.Id),
			Value:           pulumi.Any(tagDefaultValue),
			IsRequired:      pulumi.Any(tagDefaultIsRequired),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTagDefault = new Oci.Identity.TagDefault("test_tag_default", new()
    {
        CompartmentId = compartmentId,
        TagDefinitionId = testTagDefinition.Id,
        Value = tagDefaultValue,
        IsRequired = tagDefaultIsRequired,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.TagDefault;
import com.pulumi.oci.Identity.TagDefaultArgs;
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 testTagDefault = new TagDefault("testTagDefault", TagDefaultArgs.builder()
            .compartmentId(compartmentId)
            .tagDefinitionId(testTagDefinition.id())
            .value(tagDefaultValue)
            .isRequired(tagDefaultIsRequired)
            .build());

    }
}
Copy
resources:
  testTagDefault:
    type: oci:Identity:TagDefault
    name: test_tag_default
    properties:
      compartmentId: ${compartmentId}
      tagDefinitionId: ${testTagDefinition.id}
      value: ${tagDefaultValue}
      isRequired: ${tagDefaultIsRequired}
Copy

Create TagDefault Resource

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

Constructor syntax

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

@overload
def TagDefault(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               tag_definition_id: Optional[str] = None,
               value: Optional[str] = None,
               is_required: Optional[bool] = None)
func NewTagDefault(ctx *Context, name string, args TagDefaultArgs, opts ...ResourceOption) (*TagDefault, error)
public TagDefault(string name, TagDefaultArgs args, CustomResourceOptions? opts = null)
public TagDefault(String name, TagDefaultArgs args)
public TagDefault(String name, TagDefaultArgs args, CustomResourceOptions options)

type: oci:Identity:TagDefault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TagDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TagDefaultArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TagDefaultArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TagDefaultArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TagDefaultArgs
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 tagDefaultResource = new Oci.Identity.TagDefault("tagDefaultResource", new()
{
    CompartmentId = "string",
    TagDefinitionId = "string",
    Value = "string",
    IsRequired = false,
});
Copy
example, err := identity.NewTagDefault(ctx, "tagDefaultResource", &identity.TagDefaultArgs{
	CompartmentId:   pulumi.String("string"),
	TagDefinitionId: pulumi.String("string"),
	Value:           pulumi.String("string"),
	IsRequired:      pulumi.Bool(false),
})
Copy
var tagDefaultResource = new TagDefault("tagDefaultResource", TagDefaultArgs.builder()
    .compartmentId("string")
    .tagDefinitionId("string")
    .value("string")
    .isRequired(false)
    .build());
Copy
tag_default_resource = oci.identity.TagDefault("tagDefaultResource",
    compartment_id="string",
    tag_definition_id="string",
    value="string",
    is_required=False)
Copy
const tagDefaultResource = new oci.identity.TagDefault("tagDefaultResource", {
    compartmentId: "string",
    tagDefinitionId: "string",
    value: "string",
    isRequired: false,
});
Copy
type: oci:Identity:TagDefault
properties:
    compartmentId: string
    isRequired: false
    tagDefinitionId: string
    value: string
Copy

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

CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
TagDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
Value This property is required. string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

IsRequired bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
TagDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
Value This property is required. string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

IsRequired bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
tagDefinitionId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
value This property is required. String

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

isRequired Boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

compartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
tagDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
value This property is required. string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

isRequired boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

compartment_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
tag_definition_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
value This property is required. str

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

is_required bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
tagDefinitionId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
value This property is required. String

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

isRequired Boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
State string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
TagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
TagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
TimeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Id string
The provider-assigned unique ID for this managed resource.
State string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
TagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
TagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
TimeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
state String
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionName String
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId String
The OCID of the tag namespace that contains the tag definition.
timeCreated String
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
id string
The provider-assigned unique ID for this managed resource.
state string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
timeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
id str
The provider-assigned unique ID for this managed resource.
state str
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tag_definition_name str
The name used in the tag definition. This field is informational in the context of the tag default.
tag_namespace_id str
The OCID of the tag namespace that contains the tag definition.
time_created str
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
state String
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionName String
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId String
The OCID of the tag namespace that contains the tag definition.
timeCreated String
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing TagDefault Resource

Get an existing TagDefault 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?: TagDefaultState, opts?: CustomResourceOptions): TagDefault
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        is_required: Optional[bool] = None,
        state: Optional[str] = None,
        tag_definition_id: Optional[str] = None,
        tag_definition_name: Optional[str] = None,
        tag_namespace_id: Optional[str] = None,
        time_created: Optional[str] = None,
        value: Optional[str] = None) -> TagDefault
func GetTagDefault(ctx *Context, name string, id IDInput, state *TagDefaultState, opts ...ResourceOption) (*TagDefault, error)
public static TagDefault Get(string name, Input<string> id, TagDefaultState? state, CustomResourceOptions? opts = null)
public static TagDefault get(String name, Output<String> id, TagDefaultState state, CustomResourceOptions options)
resources:  _:    type: oci:Identity:TagDefault    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId Changes to this property will trigger replacement. string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
IsRequired bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

State string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
TagDefinitionId Changes to this property will trigger replacement. string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
TagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
TagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
TimeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Value string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

** 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 Changes to this property will trigger replacement. string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
IsRequired bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

State string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
TagDefinitionId Changes to this property will trigger replacement. string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
TagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
TagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
TimeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Value string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

** 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 Changes to this property will trigger replacement. String
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
isRequired Boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

state String
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionId Changes to this property will trigger replacement. String
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
tagDefinitionName String
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId String
The OCID of the tag namespace that contains the tag definition.
timeCreated String
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
value String

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

** 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 Changes to this property will trigger replacement. string
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
isRequired boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

state string
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionId Changes to this property will trigger replacement. string
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
tagDefinitionName string
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId string
The OCID of the tag namespace that contains the tag definition.
timeCreated string
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
value string

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

** 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 Changes to this property will trigger replacement. str
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
is_required bool

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

state str
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tag_definition_id Changes to this property will trigger replacement. str
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
tag_definition_name str
The name used in the tag definition. This field is informational in the context of the tag default.
tag_namespace_id str
The OCID of the tag namespace that contains the tag definition.
time_created str
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
value str

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

** 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 Changes to this property will trigger replacement. String
The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
isRequired Boolean

(Updatable) If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

state String
The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
tagDefinitionId Changes to this property will trigger replacement. String
The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
tagDefinitionName String
The name used in the tag definition. This field is informational in the context of the tag default.
tagNamespaceId String
The OCID of the tag namespace that contains the tag definition.
timeCreated String
Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
value String

(Updatable) The default value for the tag definition. This will be applied to all new resources created in the compartment.

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

Import

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

$ pulumi import oci:Identity/tagDefault:TagDefault test_tag_default "id"
Copy

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci