CreateNamedCredentialDetails¶
- class oci.database_management.models.CreateNamedCredentialDetails(**kwargs)¶
Bases:
objectThe details required to create a named credential.
Attributes:
A constant which can be used with the scope property of a CreateNamedCredentialDetails.
A constant which can be used with the scope property of a CreateNamedCredentialDetails.
A constant which can be used with the type property of a CreateNamedCredentialDetails.
Gets the associated_resource of this CreateNamedCredentialDetails.
[Required] Gets the compartment_id of this CreateNamedCredentialDetails.
[Required] Gets the content of this CreateNamedCredentialDetails.
Gets the defined_tags of this CreateNamedCredentialDetails.
Gets the description of this CreateNamedCredentialDetails.
Gets the freeform_tags of this CreateNamedCredentialDetails.
[Required] Gets the name of this CreateNamedCredentialDetails.
[Required] Gets the scope of this CreateNamedCredentialDetails.
[Required] Gets the type of this CreateNamedCredentialDetails.
Methods:
__init__(**kwargs)Initializes a new CreateNamedCredentialDetails object with values from keyword arguments.
- SCOPE_GLOBAL = 'GLOBAL'¶
A constant which can be used with the scope property of a CreateNamedCredentialDetails. This constant has a value of “GLOBAL”
- SCOPE_RESOURCE = 'RESOURCE'¶
A constant which can be used with the scope property of a CreateNamedCredentialDetails. This constant has a value of “RESOURCE”
- TYPE_ORACLE_DB = 'ORACLE_DB'¶
A constant which can be used with the type property of a CreateNamedCredentialDetails. This constant has a value of “ORACLE_DB”
- __init__(**kwargs)¶
Initializes a new CreateNamedCredentialDetails 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 CreateNamedCredentialDetails.
description (str) – The value to assign to the description property of this CreateNamedCredentialDetails.
scope (str) – The value to assign to the scope property of this CreateNamedCredentialDetails. Allowed values for this property are: “RESOURCE”, “GLOBAL”
type (str) – The value to assign to the type property of this CreateNamedCredentialDetails. Allowed values for this property are: “ORACLE_DB”
content (oci.database_management.models.NamedCredentialContent) – The value to assign to the content property of this CreateNamedCredentialDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateNamedCredentialDetails.
associated_resource (str) – The value to assign to the associated_resource property of this CreateNamedCredentialDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateNamedCredentialDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateNamedCredentialDetails.
- property associated_resource¶
Gets the associated_resource of this CreateNamedCredentialDetails. The OCID of the resource that is associated to the named credential.
- Returns
The associated_resource of this CreateNamedCredentialDetails.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CreateNamedCredentialDetails. The OCID of the compartment in which the named credential resides.
- Returns
The compartment_id of this CreateNamedCredentialDetails.
- Return type
str
- property content¶
[Required] Gets the content of this CreateNamedCredentialDetails.
- Returns
The content of this CreateNamedCredentialDetails.
- Return type
- property defined_tags¶
Gets the defined_tags of this CreateNamedCredentialDetails. 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 CreateNamedCredentialDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateNamedCredentialDetails. The information specified by the user about the named credential.
- Returns
The description of this CreateNamedCredentialDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateNamedCredentialDetails. 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 CreateNamedCredentialDetails.
- Return type
dict(str, str)
- property name¶
[Required] Gets the name of this CreateNamedCredentialDetails. The name of the named credential. Valid characters are uppercase or lowercase letters, numbers, and “_”. The name of the named credential cannot be modified. It must be unique in the compartment and must begin with an alphabetic character.
- Returns
The name of this CreateNamedCredentialDetails.
- Return type
str
- property scope¶
[Required] Gets the scope of this CreateNamedCredentialDetails. The scope of the named credential.
Allowed values for this property are: “RESOURCE”, “GLOBAL”
- Returns
The scope of this CreateNamedCredentialDetails.
- Return type
str
- property type¶
[Required] Gets the type of this CreateNamedCredentialDetails. The type of resource associated with the named credential.
Allowed values for this property are: “ORACLE_DB”
- Returns
The type of this CreateNamedCredentialDetails.
- Return type
str