Skip to content

KeySigningKey

Source code in docs_src/capo_route_53/types/key_signing_key.py
class KeySigningKey(TypedDict, closed=True):
    name: NotRequired["capo_route_53.types.signing_key_name.SigningKeyName"]
    """<p>A string used to identify a key-signing key (KSK). <code>Name</code> can include numbers, letters, and underscores (_). <code>Name</code> must be unique for each key-signing key in the same hosted zone.</p>"""
    kms_arn: NotRequired["capo_route_53.types.signing_key_string.SigningKeyString"]
    """<p>The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The <code>KmsArn</code> must be unique for each key-signing key (KSK) in a single hosted zone.</p> <p>You must configure the customer managed key as follows:</p> <dl> <dt>Status</dt> <dd> <p>Enabled</p> </dd> <dt>Key spec</dt> <dd> <p>ECC_NIST_P256</p> </dd> <dt>Key usage</dt> <dd> <p>Sign and verify</p> </dd> <dt>Key policy</dt> <dd> <p>The key policy must give permission for the following actions:</p> <ul> <li> <p>DescribeKey</p> </li> <li> <p>GetPublicKey</p> </li> <li> <p>Sign</p> </li> </ul> <p>The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:</p> <ul> <li> <p> <code>"Service": "dnssec-route53.amazonaws.com"</code> </p> </li> </ul> </dd> </dl> <p>For more information about working with the customer managed key in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html">Key Management Service concepts</a>.</p>"""
    flag: "capo_route_53.types.signing_key_integer.SigningKeyInteger"
    """<p>An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.</p>"""
    signing_algorithm_mnemonic: NotRequired[
        "capo_route_53.types.signing_key_string.SigningKeyString"
    ]
    """<p>A string used to represent the signing algorithm. This value must follow the guidelines provided by <a href="https://tools.ietf.org/html/rfc8624#section-3.1">RFC-8624 Section 3.1</a>. </p>"""
    signing_algorithm_type: "capo_route_53.types.signing_key_integer.SigningKeyInteger"
    """<p>An integer used to represent the signing algorithm. This value must follow the guidelines provided by <a href="https://tools.ietf.org/html/rfc8624#section-3.1">RFC-8624 Section 3.1</a>. </p>"""
    digest_algorithm_mnemonic: NotRequired[
        "capo_route_53.types.signing_key_string.SigningKeyString"
    ]
    """<p>A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by <a href="https://tools.ietf.org/html/rfc8624#section-3.3">RFC-8624 Section 3.3</a>. </p>"""
    digest_algorithm_type: "capo_route_53.types.signing_key_integer.SigningKeyInteger"
    """<p>An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by <a href="https://tools.ietf.org/html/rfc8624#section-3.3">RFC-8624 Section 3.3</a>.</p>"""
    key_tag: "capo_route_53.types.signing_key_tag.SigningKeyTag"
    """<p>An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in <a href="https://tools.ietf.org/rfc/rfc4034.txt">RFC-4034 Appendix B</a>.</p>"""
    digest_value: NotRequired["capo_route_53.types.signing_key_string.SigningKeyString"]
    """<p>A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.</p>"""
    public_key: NotRequired["capo_route_53.types.signing_key_string.SigningKeyString"]
    """<p>The public key, represented as a Base64 encoding, as required by <a href="https://tools.ietf.org/rfc/rfc4034.txt"> RFC-4034 Page 5</a>.</p>"""
    ds_record: NotRequired["capo_route_53.types.signing_key_string.SigningKeyString"]
    """<p>A string that represents a delegation signer (DS) record.</p>"""
    dnskey_record: NotRequired[
        "capo_route_53.types.signing_key_string.SigningKeyString"
    ]
    """<p>A string that represents a DNSKEY record.</p>"""
    status: NotRequired["capo_route_53.types.signing_key_status.SigningKeyStatus"]
    """<p>A string that represents the current key-signing key (KSK) status.</p> <p>Status can have one of the following values:</p> <dl> <dt>ACTIVE</dt> <dd> <p>The KSK is being used for signing.</p> </dd> <dt>INACTIVE</dt> <dd> <p>The KSK is not being used for signing.</p> </dd> <dt>DELETING</dt> <dd> <p>The KSK is in the process of being deleted.</p> </dd> <dt>ACTION_NEEDED</dt> <dd> <p>There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.</p> </dd> <dt>INTERNAL_FAILURE</dt> <dd> <p>There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.</p> </dd> </dl>"""
    status_message: NotRequired[
        "capo_route_53.types.signing_key_status_message.SigningKeyStatusMessage"
    ]
    """<p>The status message provided for the following key-signing key (KSK) statuses: <code>ACTION_NEEDED</code> or <code>INTERNAL_FAILURE</code>. The status message includes information about what the problem might be and steps that you can take to correct the issue.</p>"""
    created_date: NotRequired["capo_route_53.types.time_stamp.TimeStamp"]
    """<p>The date when the key-signing key (KSK) was created.</p>"""
    last_modified_date: NotRequired["capo_route_53.types.time_stamp.TimeStamp"]
    """<p>The last time that the key-signing key (KSK) was changed.</p>"""

created_date instance-attribute

created_date: NotRequired[TimeStamp]

The date when the key-signing key (KSK) was created.

digest_algorithm_mnemonic instance-attribute

digest_algorithm_mnemonic: NotRequired[SigningKeyString]

A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

digest_algorithm_type instance-attribute

digest_algorithm_type: SigningKeyInteger

An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

digest_value instance-attribute

digest_value: NotRequired[SigningKeyString]

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.

dnskey_record instance-attribute

dnskey_record: NotRequired[SigningKeyString]

A string that represents a DNSKEY record.

ds_record instance-attribute

ds_record: NotRequired[SigningKeyString]

A string that represents a delegation signer (DS) record.

flag instance-attribute

An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.

key_tag instance-attribute

key_tag: SigningKeyTag

An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.

kms_arn instance-attribute

kms_arn: NotRequired[SigningKeyString]

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

You must configure the customer managed key as follows:

Status

Enabled

Key spec

ECC_NIST_P256

Key usage

Sign and verify

Key policy

The key policy must give permission for the following actions:

  • DescribeKey

  • GetPublicKey

  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with the customer managed key in KMS, see Key Management Service concepts.

last_modified_date instance-attribute

last_modified_date: NotRequired[TimeStamp]

The last time that the key-signing key (KSK) was changed.

name instance-attribute

name: NotRequired[SigningKeyName]

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

public_key instance-attribute

public_key: NotRequired[SigningKeyString]

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

signing_algorithm_mnemonic instance-attribute

signing_algorithm_mnemonic: NotRequired[SigningKeyString]

A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

signing_algorithm_type instance-attribute

signing_algorithm_type: SigningKeyInteger

An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

status instance-attribute

status: NotRequired[SigningKeyStatus]

A string that represents the current key-signing key (KSK) status.

Status can have one of the following values:

ACTIVE

The KSK is being used for signing.

INACTIVE

The KSK is not being used for signing.

DELETING

The KSK is in the process of being deleted.

ACTION_NEEDED

There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.

INTERNAL_FAILURE

There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.

status_message instance-attribute

status_message: NotRequired[SigningKeyStatusMessage]

The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.