Docs Home
Packages
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
oci.Identity.DynamicGroup
Explore with Pulumi AI
This resource provides the Dynamic Group resource in Oracle Cloud Infrastructure Identity service.
Creates a new dynamic group in your tenancy.
You must specify your tenancy’s OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers.
You must also specify a name for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see How Policies Work.
You must also specify a description for the dynamic group (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateDynamicGroup.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDynamicGroup = new oci.identity.DynamicGroup("test_dynamic_group", {
compartmentId: tenancyOcid,
description: dynamicGroupDescription,
matchingRule: dynamicGroupMatchingRule,
name: dynamicGroupName,
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_dynamic_group = oci.identity.DynamicGroup("test_dynamic_group",
compartment_id=tenancy_ocid,
description=dynamic_group_description,
matching_rule=dynamic_group_matching_rule,
name=dynamic_group_name,
defined_tags={
"Operations.CostCenter": "42",
},
freeform_tags={
"Department": "Finance",
})
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.NewDynamicGroup(ctx, "test_dynamic_group", &Identity.DynamicGroupArgs{
CompartmentId: pulumi.Any(tenancyOcid),
Description: pulumi.Any(dynamicGroupDescription),
MatchingRule: pulumi.Any(dynamicGroupMatchingRule),
Name: pulumi.Any(dynamicGroupName),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
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 testDynamicGroup = new Oci.Identity.DynamicGroup("test_dynamic_group", new()
{
CompartmentId = tenancyOcid,
Description = dynamicGroupDescription,
MatchingRule = dynamicGroupMatchingRule,
Name = dynamicGroupName,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.DynamicGroup;
import com.pulumi.oci.Identity.DynamicGroupArgs;
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 testDynamicGroup = new DynamicGroup("testDynamicGroup", DynamicGroupArgs.builder()
.compartmentId(tenancyOcid)
.description(dynamicGroupDescription)
.matchingRule(dynamicGroupMatchingRule)
.name(dynamicGroupName)
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testDynamicGroup:
type: oci:Identity:DynamicGroup
name: test_dynamic_group
properties:
compartmentId: ${tenancyOcid}
description: ${dynamicGroupDescription}
matchingRule: ${dynamicGroupMatchingRule}
name: ${dynamicGroupName}
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
Create DynamicGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DynamicGroup(name: string, args: DynamicGroupArgs, opts?: CustomResourceOptions);@overload
def DynamicGroup(resource_name: str,
args: DynamicGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DynamicGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
description: Optional[str] = None,
matching_rule: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
name: Optional[str] = None)func NewDynamicGroup(ctx *Context, name string, args DynamicGroupArgs, opts ...ResourceOption) (*DynamicGroup, error)public DynamicGroup(string name, DynamicGroupArgs args, CustomResourceOptions? opts = null)
public DynamicGroup(String name, DynamicGroupArgs args)
public DynamicGroup(String name, DynamicGroupArgs args, CustomResourceOptions options)
type: oci:Identity:DynamicGroup
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 DynamicGroupArgs
- 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 DynamicGroupArgs
- 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 DynamicGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DynamicGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DynamicGroupArgs
- 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 dynamicGroupResource = new Oci.Identity.DynamicGroup("dynamicGroupResource", new()
{
CompartmentId = "string",
Description = "string",
MatchingRule = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
Name = "string",
});
example, err := Identity.NewDynamicGroup(ctx, "dynamicGroupResource", &Identity.DynamicGroupArgs{
CompartmentId: pulumi.String("string"),
Description: pulumi.String("string"),
MatchingRule: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var dynamicGroupResource = new DynamicGroup("dynamicGroupResource", DynamicGroupArgs.builder()
.compartmentId("string")
.description("string")
.matchingRule("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.name("string")
.build());
dynamic_group_resource = oci.identity.DynamicGroup("dynamicGroupResource",
compartment_id="string",
description="string",
matching_rule="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
},
name="string")
const dynamicGroupResource = new oci.identity.DynamicGroup("dynamicGroupResource", {
compartmentId: "string",
description: "string",
matchingRule: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
name: "string",
});
type: oci:Identity:DynamicGroup
properties:
compartmentId: string
definedTags:
string: string
description: string
freeformTags:
string: string
matchingRule: string
name: string
DynamicGroup 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 DynamicGroup resource accepts the following input properties:
- Compartment
Id string - The OCID of the tenancy containing the group.
- Description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 - The OCID of the tenancy containing the group.
- Description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 - The OCID of the tenancy containing the group.
- description String
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- matching
Rule String - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - name String
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 - The OCID of the tenancy containing the group.
- description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 - The OCID of the tenancy containing the group.
- description str
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- matching_
rule str - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - name str
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 - The OCID of the tenancy containing the group.
- description String
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- matching
Rule String - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - name String
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 DynamicGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Inactive
State string - The detailed status of INACTIVE lifecycleState.
- State string
- The group's current state.
- Time
Created string - Date and time the group 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.
- Inactive
State string - The detailed status of INACTIVE lifecycleState.
- State string
- The group's current state.
- Time
Created string - Date and time the group 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.
- inactive
State String - The detailed status of INACTIVE lifecycleState.
- state String
- The group's current state.
- time
Created String - Date and time the group 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.
- inactive
State string - The detailed status of INACTIVE lifecycleState.
- state string
- The group's current state.
- time
Created string - Date and time the group 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.
- inactive_
state str - The detailed status of INACTIVE lifecycleState.
- state str
- The group's current state.
- time_
created str - Date and time the group 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.
- inactive
State String - The detailed status of INACTIVE lifecycleState.
- state String
- The group's current state.
- time
Created String - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing DynamicGroup Resource
Get an existing DynamicGroup 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?: DynamicGroupState, opts?: CustomResourceOptions): DynamicGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
inactive_state: Optional[str] = None,
matching_rule: Optional[str] = None,
name: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None) -> DynamicGroupfunc GetDynamicGroup(ctx *Context, name string, id IDInput, state *DynamicGroupState, opts ...ResourceOption) (*DynamicGroup, error)public static DynamicGroup Get(string name, Input<string> id, DynamicGroupState? state, CustomResourceOptions? opts = null)public static DynamicGroup get(String name, Output<String> id, DynamicGroupState 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 - The OCID of the tenancy containing the group.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inactive
State string - The detailed status of INACTIVE lifecycleState.
- Matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- Time
Created string - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Compartment
Id string - The OCID of the tenancy containing the group.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - Inactive
State string - The detailed status of INACTIVE lifecycleState.
- Matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- Name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- Time
Created string - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - The OCID of the tenancy containing the group.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inactive
State String - The detailed status of INACTIVE lifecycleState.
- matching
Rule String - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- name String
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- time
Created String - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id string - The OCID of the tenancy containing the group.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description string
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inactive
State string - The detailed status of INACTIVE lifecycleState.
- matching
Rule string - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- name string
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- time
Created string - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment_
id str - The OCID of the tenancy containing the group.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description str
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inactive_
state str - The detailed status of INACTIVE lifecycleState.
- matching_
rule str - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- name str
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- time_
created str - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - The OCID of the tenancy containing the group.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- (Updatable) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"} - inactive
State String - The detailed status of INACTIVE lifecycleState.
- matching
Rule String - (Updatable) The matching rule to dynamically match an instance certificate to this dynamic group. For rule syntax, see Managing Dynamic Groups.
- name String
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
** 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 group's current state.
- time
Created String - Date and time the group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Import
DynamicGroups can be imported using the id, e.g.
$ pulumi import oci:Identity/dynamicGroup:DynamicGroup test_dynamic_group "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.