[ aws . route53 ]

get-dnssec

Description

Returns information about DNSSEC for a specific hosted zone, including the key signing keys (KSKs) and zone signing keys (ZSKs) in the hosted zone.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-dnssec
--hosted-zone-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--hosted-zone-id (string)

A unique string used to identify a hosted zone.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Status -> (structure)

A string repesenting the status of DNSSEC.

ServeSignature -> (string)

Indicates your hosted zone signging status: SIGNING , NOT_SIGNING , or INTERNAL_FAILURE . If the status is INTERNAL_FAILURE , see StatusMessage for information about steps that you can take to correct the problem.

A status INTERNAL_FAILURE means there was an error during a request. Before you can continue to work with DNSSEC signing, including working with key signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.

StatusMessage -> (string)

The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE . The status message includes information about what the problem might be and steps that you can take to correct the issue.

KeySigningKeys -> (list)

The key signing keys (KSKs) in your account.

(structure)

A key signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate a digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always associated with a hosted zone; it cannot exist by itself.

Name -> (string)

An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone.

KmsArn -> (string)

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

You must configure the CMK 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": "api-service.dnssec.route53.aws.internal"

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

Flag -> (integer)

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

SigningAlgorithmMnemonic -> (string)

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

SigningAlgorithmType -> (integer)

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

DigestAlgorithmMnemonic -> (string)

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

DigestAlgorithmType -> (integer)

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

KeyTag -> (integer)

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 .

DigestValue -> (string)

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.

PublicKey -> (string)

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

DSRecord -> (string)

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

DNSKEYRecord -> (string)

A string that represents a DNSKEY record.

Status -> (string)

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.

ACTION_NEEDED

There is an error in the KSK that requires you to take action to resolve.

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.

StatusMessage -> (string)

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.

CreatedDate -> (timestamp)

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

LastModifiedDate -> (timestamp)

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