NamedCredential

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

Bases: object

A representation of a named credential in the Management Agent.

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.

defined_tags

[Required] Gets the defined_tags of this NamedCredential.

description

Gets the description of this NamedCredential.

freeform_tags

[Required] Gets the freeform_tags of this NamedCredential.

id

[Required] Gets the id of this NamedCredential.

lifecycle_state

Gets the lifecycle_state of this NamedCredential.

management_agent_id

[Required] Gets the management_agent_id of this NamedCredential.

name

[Required] Gets the name of this NamedCredential.

properties

[Required] Gets the properties of this NamedCredential.

system_tags

Gets the system_tags of this NamedCredential.

time_created

Gets the time_created of this NamedCredential.

time_updated

Gets the time_updated of this NamedCredential.

type

[Required] 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”

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

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

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

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

  • description (str) – The value to assign to the description 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.

  • 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’.

  • properties (list[oci.management_agent.models.NamedCredentialProperty]) – The value to assign to the properties 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 defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this NamedCredential. Description of the Named Credential.

Returns

The description of this NamedCredential.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this NamedCredential. Identifier for Named Credential.

Returns

The id of this NamedCredential.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this NamedCredential. The current 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 management_agent_id

[Required] Gets the management_agent_id of this NamedCredential. The Management Agent parent resource to associated with this named credential. This is the ManagementAgent resource OCID.

Returns

The management_agent_id of this NamedCredential.

Return type

str

property name

[Required] Gets the name of this NamedCredential. Name for Named Credential. This is unique for the Management Agent.

Returns

The name of this NamedCredential.

Return type

str

property properties

[Required] Gets the properties of this NamedCredential. Properties for the named credential

Returns

The properties of this NamedCredential.

Return type

list[oci.management_agent.models.NamedCredentialProperty]

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this NamedCredential. The time the Named Credential was created. An RFC3339 formatted datetime string

Returns

The time_created of this NamedCredential.

Return type

datetime

property time_updated

Gets the time_updated of this NamedCredential. The time the Named Credential data was last updated. An RFC3339 formatted datetime string

Returns

The time_updated of this NamedCredential.

Return type

datetime

property type

[Required] Gets the type of this NamedCredential. The type of the Named Credential.

Returns

The type of this NamedCredential.

Return type

str