OciCacheUser¶

class oci.redis.models.OciCacheUser(**kwargs)¶

Bases: object

An OCI cache user is required to connect to an OCI cache cluster.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OciCacheUser.
`STATUS_OFF`	A constant which can be used with the status property of a OciCacheUser.
`STATUS_ON`	A constant which can be used with the status property of a OciCacheUser.
`acl_string`	[Required] Gets the acl_string of this OciCacheUser.
`authentication_mode`	[Required] Gets the authentication_mode of this OciCacheUser.
`compartment_id`	[Required] Gets the compartment_id of this OciCacheUser.
`defined_tags`	Gets the defined_tags of this OciCacheUser.
`description`	Gets the description of this OciCacheUser.
`freeform_tags`	Gets the freeform_tags of this OciCacheUser.
`id`	[Required] Gets the id of this OciCacheUser.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OciCacheUser.
`name`	[Required] Gets the name of this OciCacheUser.
`status`	[Required] Gets the status of this OciCacheUser.
`system_tags`	Gets the system_tags of this OciCacheUser.
`time_created`	Gets the time_created of this OciCacheUser.
`time_updated`	Gets the time_updated of this OciCacheUser.

Methods

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

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

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

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

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

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

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

STATUS_OFF = 'OFF'¶: A constant which can be used with the status property of a OciCacheUser. This constant has a value of “OFF”

STATUS_ON = 'ON'¶: A constant which can be used with the status property of a OciCacheUser. This constant has a value of “ON”

__init__(**kwargs)¶

Initializes a new OciCacheUser 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 OciCacheUser.
name (str) – The value to assign to the name property of this OciCacheUser.
description (str) – The value to assign to the description property of this OciCacheUser.
compartment_id (str) – The value to assign to the compartment_id property of this OciCacheUser.
authentication_mode (oci.redis.models.AuthenticationMode) – The value to assign to the authentication_mode property of this OciCacheUser.
acl_string (str) – The value to assign to the acl_string property of this OciCacheUser.
status (str) – The value to assign to the status property of this OciCacheUser. Allowed values for this property are: “ON”, “OFF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OciCacheUser. 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’.
time_created (datetime) – The value to assign to the time_created property of this OciCacheUser.
time_updated (datetime) – The value to assign to the time_updated property of this OciCacheUser.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OciCacheUser.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OciCacheUser.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OciCacheUser.

acl_string¶

[Required] Gets the acl_string of this OciCacheUser. ACL string of OCI cache user.

Returns:	The acl_string of this OciCacheUser.
Return type:	str

authentication_mode¶

[Required] Gets the authentication_mode of this OciCacheUser.

Returns:	The authentication_mode of this OciCacheUser.
Return type:	oci.redis.models.AuthenticationMode

compartment_id¶

[Required] Gets the compartment_id of this OciCacheUser. OCI Cache user compartment ID.

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

defined_tags¶

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

description¶

Gets the description of this OciCacheUser. Description of OCI cache user.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this OciCacheUser. OCI Cache user unique ID.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OciCacheUser. OCI Cache user lifecycle state.

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

name¶

[Required] Gets the name of this OciCacheUser. OCI Cache user name.

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

status¶

[Required] Gets the status of this OciCacheUser. OCI Cache user status. ON enables and OFF disables the OCI cache user to login to the cluster.

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

Returns:	The status of this OciCacheUser.
Return type:	str

system_tags¶

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

time_created¶

Gets the time_created of this OciCacheUser. The date and time, when the OCI cache user was created.

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

time_updated¶

Gets the time_updated of this OciCacheUser. The date and time, when the OCI cache user was updated.

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