CreateBdsApiKeyDetails¶

class oci.bds.models.CreateBdsApiKeyDetails(**kwargs)¶

Bases: object

API key created on user’s behalf.

Methods

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

Attributes

`default_region`	Gets the default_region of this CreateBdsApiKeyDetails.
`domain_ocid`	Gets the domain_ocid of this CreateBdsApiKeyDetails.
`key_alias`	[Required] Gets the key_alias of this CreateBdsApiKeyDetails.
`passphrase`	[Required] Gets the passphrase of this CreateBdsApiKeyDetails.
`user_id`	[Required] Gets the user_id of this CreateBdsApiKeyDetails.

__init__(**kwargs)¶

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

Parameters:

user_id (str) – The value to assign to the user_id property of this CreateBdsApiKeyDetails.
passphrase (str) – The value to assign to the passphrase property of this CreateBdsApiKeyDetails.
default_region (str) – The value to assign to the default_region property of this CreateBdsApiKeyDetails.
key_alias (str) – The value to assign to the key_alias property of this CreateBdsApiKeyDetails.
domain_ocid (str) – The value to assign to the domain_ocid property of this CreateBdsApiKeyDetails.

default_region¶

Gets the default_region of this CreateBdsApiKeyDetails. The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information.

Returns:	The default_region of this CreateBdsApiKeyDetails.
Return type:	str

domain_ocid¶

Gets the domain_ocid of this CreateBdsApiKeyDetails. Identity domain OCID , where user is present. For default domain , this field will be optional.

Returns:	The domain_ocid of this CreateBdsApiKeyDetails.
Return type:	str

key_alias¶

[Required] Gets the key_alias of this CreateBdsApiKeyDetails. User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed.

Returns:	The key_alias of this CreateBdsApiKeyDetails.
Return type:	str

passphrase¶

[Required] Gets the passphrase of this CreateBdsApiKeyDetails. Base64 passphrase used to secure the private key which will be created on user behalf.

Returns:	The passphrase of this CreateBdsApiKeyDetails.
Return type:	str

user_id¶

[Required] Gets the user_id of this CreateBdsApiKeyDetails. The OCID of the user for whom this new generated API key pair will be created.

Returns:	The user_id of this CreateBdsApiKeyDetails.
Return type:	str