IotDomain¶

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

Bases: object

An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group.

To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a IotDomain.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a IotDomain.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a IotDomain.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a IotDomain.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a IotDomain.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a IotDomain.
`compartment_id`	[Required] Gets the compartment_id of this IotDomain.
`data_retention_periods_in_days`	Gets the data_retention_periods_in_days of this IotDomain.
`db_allow_listed_identity_group_names`	Gets the db_allow_listed_identity_group_names of this IotDomain.
`db_allowed_identity_domain_host`	Gets the db_allowed_identity_domain_host of this IotDomain.
`defined_tags`	Gets the defined_tags of this IotDomain.
`description`	Gets the description of this IotDomain.
`device_host`	Gets the device_host of this IotDomain.
`display_name`	[Required] Gets the display_name of this IotDomain.
`freeform_tags`	Gets the freeform_tags of this IotDomain.
`id`	[Required] Gets the id of this IotDomain.
`iot_domain_group_id`	[Required] Gets the iot_domain_group_id of this IotDomain.
`lifecycle_state`	[Required] Gets the lifecycle_state of this IotDomain.
`system_tags`	Gets the system_tags of this IotDomain.
`time_created`	[Required] Gets the time_created of this IotDomain.
`time_updated`	Gets the time_updated of this IotDomain.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new IotDomain 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 IotDomain.
iot_domain_group_id (str) – The value to assign to the iot_domain_group_id property of this IotDomain.
compartment_id (str) – The value to assign to the compartment_id property of this IotDomain.
display_name (str) – The value to assign to the display_name property of this IotDomain.
description (str) – The value to assign to the description property of this IotDomain.
device_host (str) – The value to assign to the device_host property of this IotDomain.
db_allow_listed_identity_group_names (list[str]) – The value to assign to the db_allow_listed_identity_group_names property of this IotDomain.
db_allowed_identity_domain_host (str) – The value to assign to the db_allowed_identity_domain_host property of this IotDomain.
data_retention_periods_in_days (oci.iot.models.DataRetentionPeriodsInDays) – The value to assign to the data_retention_periods_in_days property of this IotDomain.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IotDomain. 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 IotDomain.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IotDomain.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IotDomain.
time_created (datetime) – The value to assign to the time_created property of this IotDomain.
time_updated (datetime) – The value to assign to the time_updated property of this IotDomain.

compartment_id¶

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

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

data_retention_periods_in_days¶

Gets the data_retention_periods_in_days of this IotDomain.

Returns:	The data_retention_periods_in_days of this IotDomain.
Return type:	oci.iot.models.DataRetentionPeriodsInDays

db_allow_listed_identity_group_names¶

Gets the db_allow_listed_identity_group_names of this IotDomain. List of IAM groups of form described in here that are allowed to directly connect to the data host.

Returns:	The db_allow_listed_identity_group_names of this IotDomain.
Return type:	list[str]

db_allowed_identity_domain_host¶

Gets the db_allowed_identity_domain_host of this IotDomain. Host name of identity domain that is used for authenticating connect to data host via ORDS.

Returns:	The db_allowed_identity_domain_host of this IotDomain.
Return type:	str

defined_tags¶

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

description¶

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

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

device_host¶

Gets the device_host of this IotDomain. Host name of an IoT domain, where IoT devices can connect to.

Returns:	The device_host of this IotDomain.
Return type:	str

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

iot_domain_group_id¶

[Required] Gets the iot_domain_group_id of this IotDomain. The OCID of the IoT domain group.

Returns:	The iot_domain_group_id of this IotDomain.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this IotDomain. The current state of the IoT domain.

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 IotDomain.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this IotDomain. 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 IotDomain.
Return type:	datetime

time_updated¶

Gets the time_updated of this IotDomain. 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 IotDomain.
Return type:	datetime