BdsApiKeySummary¶

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

Bases: object

The API key summary.

Methods

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

Attributes

`default_region`	[Required] Gets the default_region of this BdsApiKeySummary.
`id`	[Required] Gets the id of this BdsApiKeySummary.
`key_alias`	[Required] Gets the key_alias of this BdsApiKeySummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BdsApiKeySummary.
`time_created`	[Required] Gets the time_created of this BdsApiKeySummary.

__init__(**kwargs)¶

Initializes a new BdsApiKeySummary 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 BdsApiKeySummary.
key_alias (str) – The value to assign to the key_alias property of this BdsApiKeySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BdsApiKeySummary.
default_region (str) – The value to assign to the default_region property of this BdsApiKeySummary.
time_created (datetime) – The value to assign to the time_created property of this BdsApiKeySummary.

default_region¶

[Required] Gets the default_region of this BdsApiKeySummary. The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .

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

id¶

[Required] Gets the id of this BdsApiKeySummary. Identifier of the user’s API key.

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

key_alias¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this BdsApiKeySummary. The current status of the API key.

Returns:	The lifecycle_state of this BdsApiKeySummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this BdsApiKeySummary. The time the API key was created, shown as an RFC 3339 formatted datetime string.

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