CreateTsigKeyDetails

class oci.dns.models.CreateTsigKeyDetails(**kwargs)

Bases: object

The body for defining a TSIG key.

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

Methods:

__init__(**kwargs)

Initializes a new CreateTsigKeyDetails object with values from keyword arguments.

Attributes:

algorithm

[Required] Gets the algorithm of this CreateTsigKeyDetails.

compartment_id

[Required] Gets the compartment_id of this CreateTsigKeyDetails.

defined_tags

Gets the defined_tags of this CreateTsigKeyDetails.

freeform_tags

Gets the freeform_tags of this CreateTsigKeyDetails.

name

[Required] Gets the name of this CreateTsigKeyDetails.

secret

[Required] Gets the secret of this CreateTsigKeyDetails.

__init__(**kwargs)

Initializes a new CreateTsigKeyDetails 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 CreateTsigKeyDetails.

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

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateTsigKeyDetails.

  • secret (str) – The value to assign to the secret property of this CreateTsigKeyDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateTsigKeyDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateTsigKeyDetails.

property algorithm

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

Return type

str

property compartment_id

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

Returns

The compartment_id of this CreateTsigKeyDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateTsigKeyDetails. 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 CreateTsigKeyDetails.

Return type

dict(str, dict(str, object))

property freeform_tags

Gets the freeform_tags of this CreateTsigKeyDetails. 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 CreateTsigKeyDetails.

Return type

dict(str, str)

property name

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

Returns

The name of this CreateTsigKeyDetails.

Return type

str

property secret

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

Returns

The secret of this CreateTsigKeyDetails.

Return type

str