IotDomainGroup¶

class oci.iot.models.IotDomainGroup(**kwargs)¶

Bases: object

An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing IoT domains, within a compartment.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a IotDomainGroup.
`compartment_id`	[Required] Gets the compartment_id of this IotDomainGroup.
`data_host`	Gets the data_host of this IotDomainGroup.
`db_allow_listed_vcn_ids`	Gets the db_allow_listed_vcn_ids of this IotDomainGroup.
`db_connection_string`	Gets the db_connection_string of this IotDomainGroup.
`db_token_scope`	Gets the db_token_scope of this IotDomainGroup.
`defined_tags`	Gets the defined_tags of this IotDomainGroup.
`description`	Gets the description of this IotDomainGroup.
`display_name`	[Required] Gets the display_name of this IotDomainGroup.
`freeform_tags`	Gets the freeform_tags of this IotDomainGroup.
`id`	[Required] Gets the id of this IotDomainGroup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this IotDomainGroup.
`system_tags`	Gets the system_tags of this IotDomainGroup.
`time_created`	[Required] Gets the time_created of this IotDomainGroup.
`time_updated`	Gets the time_updated of this IotDomainGroup.

Methods

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

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a IotDomainGroup. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a IotDomainGroup. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new IotDomainGroup 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 IotDomainGroup.
compartment_id (str) – The value to assign to the compartment_id property of this IotDomainGroup.
display_name (str) – The value to assign to the display_name property of this IotDomainGroup.
description (str) – The value to assign to the description property of this IotDomainGroup.
data_host (str) – The value to assign to the data_host property of this IotDomainGroup.
db_allow_listed_vcn_ids (list[str]) – The value to assign to the db_allow_listed_vcn_ids property of this IotDomainGroup.
db_connection_string (str) – The value to assign to the db_connection_string property of this IotDomainGroup.
db_token_scope (str) – The value to assign to the db_token_scope property of this IotDomainGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IotDomainGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IotDomainGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IotDomainGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IotDomainGroup.
time_created (datetime) – The value to assign to the time_created property of this IotDomainGroup.
time_updated (datetime) – The value to assign to the time_updated property of this IotDomainGroup.

compartment_id¶

[Required] Gets the compartment_id of this IotDomainGroup. The OCID of the compartment corresponding to the resource.

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

data_host¶

Gets the data_host of this IotDomainGroup. The host name of the database corresponding to the IoT Domain group.

Returns:	The data_host of this IotDomainGroup.
Return type:	str

db_allow_listed_vcn_ids¶

Gets the db_allow_listed_vcn_ids of this IotDomainGroup. This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host.

Returns:	The db_allow_listed_vcn_ids of this IotDomainGroup.
Return type:	list[str]

db_connection_string¶

Gets the db_connection_string of this IotDomainGroup. The connection string used to connect to the data host associated with the IoT domain group.

Returns:	The db_connection_string of this IotDomainGroup.
Return type:	str

db_token_scope¶

Gets the db_token_scope of this IotDomainGroup. The token scope used to connect to the data host associated with the IoT domain group.

Returns:	The db_token_scope of this IotDomainGroup.
Return type:	str

defined_tags¶

Gets the defined_tags of this IotDomainGroup. 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 IotDomainGroup.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this IotDomainGroup. A short description of the resource.

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

display_name¶

[Required] Gets the display_name of this IotDomainGroup. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this IotDomainGroup.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this IotDomainGroup. 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 IotDomainGroup.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this IotDomainGroup. The OCID of the resource.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this IotDomainGroup. The current state of an IoT Domain Group.

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

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

system_tags¶

Gets the system_tags of this IotDomainGroup. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this IotDomainGroup.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this IotDomainGroup. The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this IotDomainGroup. The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this IotDomainGroup.
Return type:	datetime