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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53/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

Instance Attribute Details

#created_dateTime

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

Returns:

  • (Time)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_mnemonicString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_typeInteger

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

Returns:

  • (Integer)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_valueString

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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_recordString

A string that represents a DNSKEY record.

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_recordString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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

#flagInteger

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

Returns:

  • (Integer)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_tagInteger

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.

Returns:

  • (Integer)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_arnString

The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in AWS Key Management Service (AWS 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 CMK in AWS KMS, see AWS Key Management Service concepts.

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_dateTime

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

Returns:

  • (Time)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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

#nameString

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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_keyString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_mnemonicString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_typeInteger

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

Returns:

  • (Integer)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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

#statusString

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 customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK 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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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_messageString

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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-route53/lib/aws-sdk-route53/types.rb', line 4421

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