KeySigningKey (AWS Java SDK :: Services :: Amazon Route53 2.17.269 API)

java.lang.Object
- software.amazon.awssdk.services.route53.model.KeySigningKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KeySigningKey.Builder,KeySigningKey>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class KeySigningKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeySigningKey.Builder,KeySigningKey>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface KeySigningKey.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`KeySigningKey.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static KeySigningKey.Builder`	`builder()`
`Instant`	`createdDate()` The date when the key-signing key (KSK) was created.
`String`	`digestAlgorithmMnemonic()` A string used to represent the delegation signer digest algorithm.
`Integer`	`digestAlgorithmType()` An integer used to represent the delegation signer digest algorithm.
`String`	`digestValue()` A cryptographic digest of a DNSKEY resource record (RR).
`String`	`dnskeyRecord()` A string that represents a DNSKEY record.
`String`	`dsRecord()` A string that represents a delegation signer (DS) record.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`flag()` An integer that specifies how the key is used.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`keyTag()` An integer used to identify the DNSSEC record for the domain name.
`String`	`kmsArn()` The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
`Instant`	`lastModifiedDate()` The last time that the key-signing key (KSK) was changed.
`String`	`name()` A string used to identify a key-signing key (KSK).
`String`	`publicKey()` The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KeySigningKey.Builder>`	`serializableBuilderClass()`
`String`	`signingAlgorithmMnemonic()` A string used to represent the signing algorithm.
`Integer`	`signingAlgorithmType()` An integer used to represent the signing algorithm.
`String`	`status()` A string that represents the current key-signing key (KSK) status.
`String`	`statusMessage()` The status message provided for the following key-signing key (KSK) statuses: `ACTION_NEEDED` or `INTERNAL_FAILURE`.
`KeySigningKey.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final 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.
    
    Returns:
    
    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.
  - kmsArn
```
public final 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.
    Returns:
    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.
  - flag
```
public final Integer flag()
```
    An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
    
    Returns:
    
    An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
  - signingAlgorithmMnemonic
```
public final String signingAlgorithmMnemonic()
```
    A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
    
    Returns:
    
    A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
  - signingAlgorithmType
```
public final Integer signingAlgorithmType()
```
    An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
    
    Returns:
    
    An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
  - digestAlgorithmMnemonic
```
public final 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.
    
    Returns:
    
    A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
  - digestAlgorithmType
```
public final 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.
    
    Returns:
    
    An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
  - keyTag
```
public final 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.
    
    Returns:
    
    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
```
public final 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.
    
    Returns:
    
    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
```
public final String publicKey()
```
    The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
    
    Returns:
    
    The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
  - dsRecord
```
public final String dsRecord()
```
    A string that represents a delegation signer (DS) record.
    
    Returns:
    
    A string that represents a delegation signer (DS) record.
  - dnskeyRecord
```
public final String dnskeyRecord()
```
    A string that represents a DNSKEY record.
    
    Returns:
    
    A string that represents a DNSKEY record.
  - status
```
public final 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.
    
    Returns:
    
    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.
  - statusMessage
```
public final 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.
    
    Returns:
    
    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
```
public final Instant createdDate()
```
    The date when the key-signing key (KSK) was created.
    
    Returns:
    
    The date when the key-signing key (KSK) was created.
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The last time that the key-signing key (KSK) was changed.
    
    Returns:
    
    The last time that the key-signing key (KSK) was changed.
  - toBuilder
```
public KeySigningKey.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KeySigningKey.Builder,KeySigningKey>
  - builder
```
public static KeySigningKey.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KeySigningKey.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class KeySigningKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

kmsArn

flag

signingAlgorithmMnemonic

signingAlgorithmType

digestAlgorithmMnemonic

digestAlgorithmType

keyTag

digestValue

publicKey

dsRecord

dnskeyRecord

status

statusMessage

createdDate

lastModifiedDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields