Domain

class oci.tenant_manager_control_plane.models.Domain(**kwargs)

Bases: object

The domain model that is associated with a tenancy.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Domain.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Domain.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Domain.
STATUS_ACTIVE A constant which can be used with the status property of a Domain.
STATUS_EXPIRING A constant which can be used with the status property of a Domain.
STATUS_FAILED A constant which can be used with the status property of a Domain.
STATUS_PENDING A constant which can be used with the status property of a Domain.
STATUS_RELEASED A constant which can be used with the status property of a Domain.
STATUS_RELEASING A constant which can be used with the status property of a Domain.
STATUS_REVOKED A constant which can be used with the status property of a Domain.
STATUS_REVOKING A constant which can be used with the status property of a Domain.
defined_tags Gets the defined_tags of this Domain.
domain_name [Required] Gets the domain_name of this Domain.
freeform_tags Gets the freeform_tags of this Domain.
id [Required] Gets the id of this Domain.
lifecycle_state [Required] Gets the lifecycle_state of this Domain.
owner_id [Required] Gets the owner_id of this Domain.
status [Required] Gets the status of this Domain.
system_tags Gets the system_tags of this Domain.
time_created Gets the time_created of this Domain.
time_updated Gets the time_updated of this Domain.
txt_record [Required] Gets the txt_record of this Domain.

Methods

__init__(**kwargs) Initializes a new Domain object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Domain. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Domain. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Domain. This constant has a value of “FAILED”

STATUS_ACTIVE = 'ACTIVE'

A constant which can be used with the status property of a Domain. This constant has a value of “ACTIVE”

STATUS_EXPIRING = 'EXPIRING'

A constant which can be used with the status property of a Domain. This constant has a value of “EXPIRING”

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a Domain. This constant has a value of “FAILED”

STATUS_PENDING = 'PENDING'

A constant which can be used with the status property of a Domain. This constant has a value of “PENDING”

STATUS_RELEASED = 'RELEASED'

A constant which can be used with the status property of a Domain. This constant has a value of “RELEASED”

STATUS_RELEASING = 'RELEASING'

A constant which can be used with the status property of a Domain. This constant has a value of “RELEASING”

STATUS_REVOKED = 'REVOKED'

A constant which can be used with the status property of a Domain. This constant has a value of “REVOKED”

STATUS_REVOKING = 'REVOKING'

A constant which can be used with the status property of a Domain. This constant has a value of “REVOKING”

__init__(**kwargs)

Initializes a new Domain 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 Domain.
  • domain_name (str) – The value to assign to the domain_name property of this Domain.
  • owner_id (str) – The value to assign to the owner_id property of this Domain.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Domain. Allowed values for this property are: “ACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • status (str) – The value to assign to the status property of this Domain. Allowed values for this property are: “PENDING”, “RELEASING”, “RELEASED”, “EXPIRING”, “REVOKING”, “REVOKED”, “ACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • txt_record (str) – The value to assign to the txt_record property of this Domain.
  • time_created (datetime) – The value to assign to the time_created property of this Domain.
  • time_updated (datetime) – The value to assign to the time_updated property of this Domain.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Domain.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Domain.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Domain.
defined_tags

Gets the defined_tags of this Domain. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

[Required] Gets the domain_name of this Domain. The domain name.

Returns:The domain_name of this Domain.
Return type:str
freeform_tags

Gets the freeform_tags of this Domain. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

[Required] Gets the id of this Domain. The OCID of the domain.

Returns:The id of this Domain.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this Domain. Lifecycle state of the domain.

Allowed values for this property are: “ACTIVE”, “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 Domain.
Return type:str
owner_id

[Required] Gets the owner_id of this Domain. The OCID of the tenancy that has started the registration process for this domain.

Returns:The owner_id of this Domain.
Return type:str
status

[Required] Gets the status of this Domain. Status of the domain.

Allowed values for this property are: “PENDING”, “RELEASING”, “RELEASED”, “EXPIRING”, “REVOKING”, “REVOKED”, “ACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The status of this Domain.
Return type:str
system_tags

Gets the system_tags of this Domain. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

Gets the time_created of this Domain. Date-time when this domain was created. An RFC3339-formatted date and time string.

Returns:The time_created of this Domain.
Return type:datetime
time_updated

Gets the time_updated of this Domain. Date-time when this domain was last updated. An RFC3339-formatted date and time string.

Returns:The time_updated of this Domain.
Return type:datetime
txt_record

[Required] Gets the txt_record of this Domain. The code that the owner of the domain will need to add as a TXT record to their domain.

Returns:The txt_record of this Domain.
Return type:str