RegistrationPolicy

class oci.data_safe.models.RegistrationPolicy(**kwargs)

Bases: object

A registration policy. This object contains detailed information about a registration policy, including its ID, compartment ID, display name, and features.

Attributes:

ENABLEMENT_LEVEL_DATABASE

A constant which can be used with the enablement_level property of a RegistrationPolicy.

FEATURES_ALL

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_ASSESSMENT

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_AUDIT_COLLECTION

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_AUDIT_SETTING

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_DATA_DISCOVERY

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_MASKING

A constant which can be used with the features property of a RegistrationPolicy.

FEATURES_SQL_FIREWALL

A constant which can be used with the features property of a RegistrationPolicy.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a RegistrationPolicy.

can_override_features

Gets the can_override_features of this RegistrationPolicy.

compartment_id

[Required] Gets the compartment_id of this RegistrationPolicy.

connection_option

Gets the connection_option of this RegistrationPolicy.

defined_tags

[Required] Gets the defined_tags of this RegistrationPolicy.

description

Gets the description of this RegistrationPolicy.

display_name

[Required] Gets the display_name of this RegistrationPolicy.

enablement_level

Gets the enablement_level of this RegistrationPolicy.

features

[Required] Gets the features of this RegistrationPolicy.

freeform_tags

[Required] Gets the freeform_tags of this RegistrationPolicy.

id

[Required] Gets the id of this RegistrationPolicy.

lifecycle_state

[Required] Gets the lifecycle_state of this RegistrationPolicy.

lifecycle_state_details

Gets the lifecycle_state_details of this RegistrationPolicy.

resource_id

[Required] Gets the resource_id of this RegistrationPolicy.

system_tags

[Required] Gets the system_tags of this RegistrationPolicy.

time_created

[Required] Gets the time_created of this RegistrationPolicy.

time_updated

[Required] Gets the time_updated of this RegistrationPolicy.

Methods:

__init__(**kwargs)

Initializes a new RegistrationPolicy object with values from keyword arguments.

ENABLEMENT_LEVEL_DATABASE = 'DATABASE'

A constant which can be used with the enablement_level property of a RegistrationPolicy. This constant has a value of “DATABASE”

FEATURES_ALL = 'ALL'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “ALL”

FEATURES_ASSESSMENT = 'ASSESSMENT'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “ASSESSMENT”

FEATURES_AUDIT_COLLECTION = 'AUDIT_COLLECTION'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “AUDIT_COLLECTION”

FEATURES_AUDIT_SETTING = 'AUDIT_SETTING'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “AUDIT_SETTING”

FEATURES_DATA_DISCOVERY = 'DATA_DISCOVERY'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “DATA_DISCOVERY”

FEATURES_MASKING = 'MASKING'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “MASKING”

FEATURES_SQL_FIREWALL = 'SQL_FIREWALL'

A constant which can be used with the features property of a RegistrationPolicy. This constant has a value of “SQL_FIREWALL”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this RegistrationPolicy.

  • id (str) – The value to assign to the id property of this RegistrationPolicy.

  • display_name (str) – The value to assign to the display_name property of this RegistrationPolicy.

  • description (str) – The value to assign to the description property of this RegistrationPolicy.

  • enablement_level (str) – The value to assign to the enablement_level property of this RegistrationPolicy. Allowed values for this property are: “DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • resource_id (str) – The value to assign to the resource_id property of this RegistrationPolicy.

  • features (list[str]) – The value to assign to the features property of this RegistrationPolicy. Allowed values for items in this list are: “ASSESSMENT”, “AUDIT_COLLECTION”, “AUDIT_SETTING”, “DATA_DISCOVERY”, “MASKING”, “SQL_FIREWALL”, “ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • can_override_features (bool) – The value to assign to the can_override_features property of this RegistrationPolicy.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RegistrationPolicy. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “NEEDS_ATTENTION”, “FAILED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this RegistrationPolicy.

  • time_created (datetime) – The value to assign to the time_created property of this RegistrationPolicy.

  • time_updated (datetime) – The value to assign to the time_updated property of this RegistrationPolicy.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RegistrationPolicy.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RegistrationPolicy.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RegistrationPolicy.

  • connection_option (oci.data_safe.models.PolicyConnectionOption) – The value to assign to the connection_option property of this RegistrationPolicy.

property can_override_features

Gets the can_override_features of this RegistrationPolicy. Indicates whether features will be overridden.

Returns

The can_override_features of this RegistrationPolicy.

Return type

bool

property compartment_id

[Required] Gets the compartment_id of this RegistrationPolicy. The OCID for the compartment containing the registration policy.

Returns

The compartment_id of this RegistrationPolicy.

Return type

str

property connection_option

Gets the connection_option of this RegistrationPolicy.

Returns

The connection_option of this RegistrationPolicy.

Return type

oci.data_safe.models.PolicyConnectionOption

property defined_tags

[Required] Gets the defined_tags of this RegistrationPolicy. 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 RegistrationPolicy.

Return type

dict(str, dict(str, object))

property description

Gets the description of this RegistrationPolicy. A description of the registration policy.

Returns

The description of this RegistrationPolicy.

Return type

str

property display_name

[Required] Gets the display_name of this RegistrationPolicy. The display name of the registration policy.

Returns

The display_name of this RegistrationPolicy.

Return type

str

property enablement_level

Gets the enablement_level of this RegistrationPolicy. The resource type which has been opted in for the registration policy. - DATABASE - The registration policy will be opted in at the Container Database level.

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

Returns

The enablement_level of this RegistrationPolicy.

Return type

str

property features

[Required] Gets the features of this RegistrationPolicy. The Data Safe features granted to the databases registering under the registration policy.

Allowed values for items in this list are: “ASSESSMENT”, “AUDIT_COLLECTION”, “AUDIT_SETTING”, “DATA_DISCOVERY”, “MASKING”, “SQL_FIREWALL”, “ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The features of this RegistrationPolicy.

Return type

list[str]

property freeform_tags

[Required] Gets the freeform_tags of this RegistrationPolicy. 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 RegistrationPolicy.

Return type

dict(str, str)

property id

[Required] Gets the id of this RegistrationPolicy. The OCID of the registration policy.

Returns

The id of this RegistrationPolicy.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this RegistrationPolicy. The lifecycle state of the registration policy. - CREATING - The registration policy is getting created. - ACTIVE - The registration policy has been successfully created. - UPDATING - The registration policy is getting updated. - NEEDS_ATTENTION - The registration policy needs attention. - FAILED - The registration policy creation or update has failed. - DELETING - The registration policy is getting deleted.

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

Returns

The lifecycle_state of this RegistrationPolicy.

Return type

str

property lifecycle_state_details

Gets the lifecycle_state_details of this RegistrationPolicy. Details about the lifecycle state of the registration policy

Returns

The lifecycle_state_details of this RegistrationPolicy.

Return type

str

property resource_id

[Required] Gets the resource_id of this RegistrationPolicy. The OCID of the resource used in the registration policy.

Returns

The resource_id of this RegistrationPolicy.

Return type

str

property system_tags

[Required] Gets the system_tags of this RegistrationPolicy. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this RegistrationPolicy.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this RegistrationPolicy. The date and time when the registration policy was created.

Returns

The time_created of this RegistrationPolicy.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this RegistrationPolicy. The date and time when the registration policy was last updated.

Returns

The time_updated of this RegistrationPolicy.

Return type

datetime