DynamicGroup¶

class oci.identity.models.DynamicGroup(**kwargs)¶

Bases: object

A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups.

This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see Managing Dynamic Groups.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DynamicGroup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DynamicGroup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DynamicGroup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DynamicGroup.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DynamicGroup.
`compartment_id`	[Required] Gets the compartment_id of this DynamicGroup.
`defined_tags`	Gets the defined_tags of this DynamicGroup.
`description`	[Required] Gets the description of this DynamicGroup.
`freeform_tags`	Gets the freeform_tags of this DynamicGroup.
`id`	[Required] Gets the id of this DynamicGroup.
`inactive_status`	Gets the inactive_status of this DynamicGroup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DynamicGroup.
`matching_rule`	[Required] Gets the matching_rule of this DynamicGroup.
`name`	[Required] Gets the name of this DynamicGroup.
`time_created`	[Required] Gets the time_created of this DynamicGroup.

Methods

__init__(**kwargs) Initializes a new DynamicGroup object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DynamicGroup. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DynamicGroup. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DynamicGroup. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DynamicGroup. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DynamicGroup. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new DynamicGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DynamicGroup.
compartment_id (str) – The value to assign to the compartment_id property of this DynamicGroup.
name (str) – The value to assign to the name property of this DynamicGroup.
description (str) – The value to assign to the description property of this DynamicGroup.
matching_rule (str) – The value to assign to the matching_rule property of this DynamicGroup.
time_created (datetime) – The value to assign to the time_created property of this DynamicGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DynamicGroup. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this DynamicGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DynamicGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DynamicGroup.

compartment_id¶

[Required] Gets the compartment_id of this DynamicGroup. The OCID of the tenancy containing the group.

Returns:	The compartment_id of this DynamicGroup.
Return type:	str

defined_tags¶

Gets the defined_tags of this DynamicGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this DynamicGroup.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this DynamicGroup. The description you assign to the group. Does not have to be unique, and it’s changeable.

(For tenancies that support identity domains) You can have an empty description.

Returns:	The description of this DynamicGroup.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DynamicGroup. 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”}

Returns:	The freeform_tags of this DynamicGroup.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DynamicGroup. The OCID of the group.

Returns:	The id of this DynamicGroup.
Return type:	str

inactive_status¶

Gets the inactive_status of this DynamicGroup. The detailed status of INACTIVE lifecycleState.

Returns:	The inactive_status of this DynamicGroup.
Return type:	int

lifecycle_state¶

[Required] Gets the lifecycle_state of this DynamicGroup. The group’s current state. After creating a group, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DynamicGroup.
Return type:	str

matching_rule¶

[Required] Gets the matching_rule of this DynamicGroup. A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.

Returns:	The matching_rule of this DynamicGroup.
Return type:	str

name¶

[Required] Gets the name of this DynamicGroup. The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Returns:	The name of this DynamicGroup.
Return type:	str

time_created¶

[Required] Gets the time_created of this DynamicGroup. Date and time the group was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this DynamicGroup.
Return type:	datetime