TsigKey¶

class oci.dns.models.TsigKey(**kwargs)¶

Bases: object

A TSIG key. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a TsigKey.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a TsigKey.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a TsigKey.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a TsigKey.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a TsigKey.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a TsigKey.
`algorithm`	[Required] Gets the algorithm of this TsigKey.
`compartment_id`	[Required] Gets the compartment_id of this TsigKey.
`defined_tags`	[Required] Gets the defined_tags of this TsigKey.
`freeform_tags`	[Required] Gets the freeform_tags of this TsigKey.
`id`	[Required] Gets the id of this TsigKey.
`lifecycle_state`	[Required] Gets the lifecycle_state of this TsigKey.
`name`	[Required] Gets the name of this TsigKey.
`secret`	[Required] Gets the secret of this TsigKey.
`time_created`	[Required] Gets the time_created of this TsigKey.
`time_updated`	Gets the time_updated of this TsigKey.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a TsigKey. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

algorithm (str) – The value to assign to the algorithm property of this TsigKey.
name (str) – The value to assign to the name property of this TsigKey.
compartment_id (str) – The value to assign to the compartment_id property of this TsigKey.
secret (str) – The value to assign to the secret property of this TsigKey.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TsigKey.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TsigKey.
id (str) – The value to assign to the id property of this TsigKey.
_self (str) – The value to assign to the _self property of this TsigKey.
time_created (datetime) – The value to assign to the time_created property of this TsigKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TsigKey. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_updated (datetime) – The value to assign to the time_updated property of this TsigKey.

algorithm¶

[Required] Gets the algorithm of this TsigKey. TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

Returns:	The algorithm of this TsigKey.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this TsigKey. The OCID of the compartment containing the TSIG key.

Returns:	The compartment_id of this TsigKey.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this TsigKey. 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 TsigKey.
Return type:	dict(str, dict(str, object))

freeform_tags¶

[Required] Gets the freeform_tags of this TsigKey. 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 TsigKey.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this TsigKey. The OCID of the resource.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this TsigKey. The current state of the resource.

Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

name¶

[Required] Gets the name of this TsigKey. A globally unique domain name identifying the key for a given pair of hosts.

Returns:	The name of this TsigKey.
Return type:	str

secret¶

[Required] Gets the secret of this TsigKey. A base64 string encoding the binary shared secret.

Returns:	The secret of this TsigKey.
Return type:	str

time_created¶

[Required] Gets the time_created of this TsigKey. The date and time the resource was created, expressed in RFC 3339 timestamp format.

Example: 2016-07-22T17:23:59:60Z

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

time_updated¶

Gets the time_updated of this TsigKey. The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

Example: 2016-07-22T17:23:59:60Z

Returns:	The time_updated of this TsigKey.
Return type:	datetime