NamedCredential

class oci.database_management.models.NamedCredential(**kwargs)

Bases: object

The details of a named credential.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_UPDATING

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

SCOPE_GLOBAL

A constant which can be used with the scope property of a NamedCredential.

SCOPE_RESOURCE

A constant which can be used with the scope property of a NamedCredential.

TYPE_ORACLE_DB

A constant which can be used with the type property of a NamedCredential.

associated_resource

Gets the associated_resource of this NamedCredential.

compartment_id

[Required] Gets the compartment_id of this NamedCredential.

content

Gets the content of this NamedCredential.

defined_tags

Gets the defined_tags of this NamedCredential.

description

Gets the description of this NamedCredential.

freeform_tags

Gets the freeform_tags of this NamedCredential.

id

[Required] Gets the id of this NamedCredential.

lifecycle_details

Gets the lifecycle_details of this NamedCredential.

lifecycle_state

[Required] Gets the lifecycle_state of this NamedCredential.

name

[Required] Gets the name of this NamedCredential.

scope

Gets the scope of this NamedCredential.

system_tags

Gets the system_tags of this NamedCredential.

time_created

[Required] Gets the time_created of this NamedCredential.

time_updated

Gets the time_updated of this NamedCredential.

type

Gets the type of this NamedCredential.

Methods:

__init__(**kwargs)

Initializes a new NamedCredential object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SCOPE_GLOBAL = 'GLOBAL'

A constant which can be used with the scope property of a NamedCredential. This constant has a value of “GLOBAL”

SCOPE_RESOURCE = 'RESOURCE'

A constant which can be used with the scope property of a NamedCredential. This constant has a value of “RESOURCE”

TYPE_ORACLE_DB = 'ORACLE_DB'

A constant which can be used with the type property of a NamedCredential. This constant has a value of “ORACLE_DB”

__init__(**kwargs)

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

Parameters
  • name (str) – The value to assign to the name property of this NamedCredential.

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this NamedCredential. 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’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this NamedCredential.

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

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

  • content (oci.database_management.models.NamedCredentialContent) – The value to assign to the content property of this NamedCredential.

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

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

  • associated_resource (str) – The value to assign to the associated_resource property of this NamedCredential.

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

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

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

property associated_resource

Gets the associated_resource of this NamedCredential. The OCID of the resource that is associated to the named credential.

Returns

The associated_resource of this NamedCredential.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this NamedCredential. The OCID of the compartment.

Returns

The compartment_id of this NamedCredential.

Return type

str

property content

Gets the content of this NamedCredential.

Returns

The content of this NamedCredential.

Return type

oci.database_management.models.NamedCredentialContent

property defined_tags

Gets the defined_tags of this NamedCredential. 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 NamedCredential.

Return type

dict(str, dict(str, object))

property description

Gets the description of this NamedCredential. The information specified by the user about the named credential.

Returns

The description of this NamedCredential.

Return type

str

property freeform_tags

Gets the freeform_tags of this NamedCredential. 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 NamedCredential.

Return type

dict(str, str)

property id

[Required] Gets the id of this NamedCredential. The OCID of the named credential.

Returns

The id of this NamedCredential.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this NamedCredential. The details of the lifecycle state.

Returns

The lifecycle_details of this NamedCredential.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this NamedCredential. The current lifecycle state of the named credential.

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 NamedCredential.

Return type

str

property name

[Required] Gets the name of this NamedCredential. The name of the named credential.

Returns

The name of this NamedCredential.

Return type

str

property scope

Gets the scope of this NamedCredential. The scope of the named credential.

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

Returns

The scope of this NamedCredential.

Return type

str

property system_tags

Gets the system_tags of this NamedCredential. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

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

Returns

The system_tags of this NamedCredential.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this NamedCredential. The date and time the named credential was created.

Returns

The time_created of this NamedCredential.

Return type

datetime

property time_updated

Gets the time_updated of this NamedCredential. The date and time the named credential was last updated.

Returns

The time_updated of this NamedCredential.

Return type

datetime

property type

Gets the type of this NamedCredential. The type of resource associated with the named credential.

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

Returns

The type of this NamedCredential.

Return type

str