software.amazon.awssdk.services.route53.model

Interface KeySigningKey.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KeySigningKey.Builder,KeySigningKey>, SdkBuilder<KeySigningKey.Builder,KeySigningKey>, SdkPojo

Enclosing class:

KeySigningKey

public static interface KeySigningKey.Builder
extends SdkPojo, CopyableBuilder<KeySigningKey.Builder,KeySigningKey>

Method Summary

Modifier and Type	Method and Description
KeySigningKey.Builder	createdDate(Instant createdDate) The date when the key-signing key (KSK) was created.
KeySigningKey.Builder	digestAlgorithmMnemonic(String digestAlgorithmMnemonic) A string used to represent the delegation signer digest algorithm.
KeySigningKey.Builder	digestAlgorithmType(Integer digestAlgorithmType) An integer used to represent the delegation signer digest algorithm.
KeySigningKey.Builder	digestValue(String digestValue) A cryptographic digest of a DNSKEY resource record (RR).
KeySigningKey.Builder	dnskeyRecord(String dnskeyRecord) A string that represents a DNSKEY record.
KeySigningKey.Builder	dsRecord(String dsRecord) A string that represents a delegation signer (DS) record.
KeySigningKey.Builder	flag(Integer flag) An integer that specifies how the key is used.
KeySigningKey.Builder	keyTag(Integer keyTag) An integer used to identify the DNSSEC record for the domain name.
KeySigningKey.Builder	kmsArn(String kmsArn) The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
KeySigningKey.Builder	lastModifiedDate(Instant lastModifiedDate) The last time that the key-signing key (KSK) was changed.
KeySigningKey.Builder	name(String name) A string used to identify a key-signing key (KSK).
KeySigningKey.Builder	publicKey(String publicKey) The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
KeySigningKey.Builder	signingAlgorithmMnemonic(String signingAlgorithmMnemonic) A string used to represent the signing algorithm.
KeySigningKey.Builder	signingAlgorithmType(Integer signingAlgorithmType) An integer used to represent the signing algorithm.
KeySigningKey.Builder	status(String status) A string that represents the current key-signing key (KSK) status.
KeySigningKey.Builder	statusMessage(String statusMessage) The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

KeySigningKey.Builder name(String name)

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.

Parameters:

name - 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:

Returns a reference to this object so that method calls can be chained together.

kmsArn

KeySigningKey.Builder kmsArn(String kmsArn)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

flag

KeySigningKey.Builder flag(Integer flag)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

signingAlgorithmMnemonic

KeySigningKey.Builder signingAlgorithmMnemonic(String signingAlgorithmMnemonic)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

signingAlgorithmType

KeySigningKey.Builder signingAlgorithmType(Integer signingAlgorithmType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

digestAlgorithmMnemonic

KeySigningKey.Builder digestAlgorithmMnemonic(String digestAlgorithmMnemonic)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

digestAlgorithmType

KeySigningKey.Builder digestAlgorithmType(Integer digestAlgorithmType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

keyTag

KeySigningKey.Builder keyTag(Integer keyTag)

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.

Parameters:

keyTag - 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:

Returns a reference to this object so that method calls can be chained together.

digestValue

KeySigningKey.Builder digestValue(String digestValue)

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.

Parameters:

digestValue - 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:

Returns a reference to this object so that method calls can be chained together.

publicKey

KeySigningKey.Builder publicKey(String publicKey)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dsRecord

KeySigningKey.Builder dsRecord(String dsRecord)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dnskeyRecord

KeySigningKey.Builder dnskeyRecord(String dnskeyRecord)

A string that represents a DNSKEY record.

Parameters:

dnskeyRecord - A string that represents a DNSKEY record.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

KeySigningKey.Builder status(String status)

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.

Parameters:

status - 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:

Returns a reference to this object so that method calls can be chained together.

statusMessage

KeySigningKey.Builder statusMessage(String statusMessage)

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.

Parameters:

statusMessage - 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:

Returns a reference to this object so that method calls can be chained together.

createdDate

KeySigningKey.Builder createdDate(Instant createdDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedDate

KeySigningKey.Builder lastModifiedDate(Instant lastModifiedDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.