Class: Aws::Route53::Types::KeySigningKey

Inherits:

Struct

Object
Struct
Aws::Route53::Types::KeySigningKey

show all

Includes:: Structure

Defined in:: lib/aws-sdk-route53/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#created_date ⇒ Time

The date when the key-signing key (KSK) was created.
#digest_algorithm_mnemonic ⇒ String

A string used to represent the delegation signer digest algorithm.
#digest_algorithm_type ⇒ Integer

An integer used to represent the delegation signer digest algorithm.
#digest_value ⇒ String

A cryptographic digest of a DNSKEY resource record (RR).
#dnskey_record ⇒ String

A string that represents a DNSKEY record.
#ds_record ⇒ String

A string that represents a delegation signer (DS) record.
#flag ⇒ Integer

An integer that specifies how the key is used.
#key_tag ⇒ Integer

An integer used to identify the DNSSEC record for the domain name.
#kms_arn ⇒ String

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
#last_modified_date ⇒ Time

The last time that the key-signing key (KSK) was changed.
#name ⇒ String

A string used to identify a key-signing key (KSK).
#public_key ⇒ String

The public key, represented as a Base64 encoding, as required by [ RFC-4034 Page 5].
#signing_algorithm_mnemonic ⇒ String

A string used to represent the signing algorithm.
#signing_algorithm_type ⇒ Integer

An integer used to represent the signing algorithm.
#status ⇒ String

A string that represents the current key-signing key (KSK) status.
#status_message ⇒ String

The status message provided for the following key-signing key (KSK) statuses: ‘ACTION_NEEDED` or `INTERNAL_FAILURE`.

Instance Attribute Details

#created_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#digest_algorithm_mnemonic ⇒ `String`

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

[1]: tools.ietf.org/html/rfc8624#section-3.3

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#digest_algorithm_type ⇒ `Integer`

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

[1]: tools.ietf.org/html/rfc8624#section-3.3

Returns:

(Integer)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#digest_value ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#dnskey_record ⇒ `String`

A string that represents a DNSKEY record.

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#ds_record ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#flag ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#key_tag ⇒ `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].

[1]: tools.ietf.org/rfc/rfc4034.txt

Returns:

(Integer)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#kms_arn ⇒ `String`

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].

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#public_key ⇒ `String`

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

[1]: tools.ietf.org/rfc/rfc4034.txt

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithm_mnemonic ⇒ `String`

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

[1]: tools.ietf.org/html/rfc8624#section-3.1

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithm_type ⇒ `Integer`

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

[1]: tools.ietf.org/html/rfc8624#section-3.1

Returns:

(Integer)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#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.

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.

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-route53/types.rb', line 4325

class KeySigningKey < Struct.new(
  :name,
  :kms_arn,
  :flag,
  :signing_algorithm_mnemonic,
  :signing_algorithm_type,
  :digest_algorithm_mnemonic,
  :digest_algorithm_type,
  :key_tag,
  :digest_value,
  :public_key,
  :ds_record,
  :dnskey_record,
  :status,
  :status_message,
  :created_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Route53::Types::KeySigningKey

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#created_date ⇒ Time

#digest_algorithm_mnemonic ⇒ String

#digest_algorithm_type ⇒ Integer

#digest_value ⇒ String

#dnskey_record ⇒ String

#ds_record ⇒ String

#flag ⇒ Integer

#key_tag ⇒ Integer

#kms_arn ⇒ String

#last_modified_date ⇒ Time

#name ⇒ String

#public_key ⇒ String

#signing_algorithm_mnemonic ⇒ String

#signing_algorithm_type ⇒ Integer

#status ⇒ String

#status_message ⇒ String

#created_date ⇒ `Time`

#digest_algorithm_mnemonic ⇒ `String`

#digest_algorithm_type ⇒ `Integer`

#digest_value ⇒ `String`

#dnskey_record ⇒ `String`

#ds_record ⇒ `String`

#flag ⇒ `Integer`

#key_tag ⇒ `Integer`

#kms_arn ⇒ `String`

#last_modified_date ⇒ `Time`

#name ⇒ `String`

#public_key ⇒ `String`

#signing_algorithm_mnemonic ⇒ `String`

#signing_algorithm_type ⇒ `Integer`

#status ⇒ `String`

#status_message ⇒ `String`