@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class KeySigningKey extends Object implements Serializable, Cloneable
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.
Constructor and Description |
---|
KeySigningKey() |
Modifier and Type | Method and Description |
---|---|
KeySigningKey |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedDate()
The date when the key-signing key (KSK) was created.
|
String |
getDigestAlgorithmMnemonic()
A string used to represent the delegation signer digest algorithm.
|
Integer |
getDigestAlgorithmType()
An integer used to represent the delegation signer digest algorithm.
|
String |
getDigestValue()
A cryptographic digest of a DNSKEY resource record (RR).
|
String |
getDNSKEYRecord()
A string that represents a DNSKEY record.
|
String |
getDSRecord()
A string that represents a delegation signer (DS) record.
|
Integer |
getFlag()
An integer that specifies how the key is used.
|
Integer |
getKeyTag()
An integer used to identify the DNSSEC record for the domain name.
|
String |
getKmsArn()
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
|
Date |
getLastModifiedDate()
The last time that the key-signing key (KSK) was changed.
|
String |
getName()
A string used to identify a key-signing key (KSK).
|
String |
getPublicKey()
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
|
String |
getSigningAlgorithmMnemonic()
A string used to represent the signing algorithm.
|
Integer |
getSigningAlgorithmType()
An integer used to represent the signing algorithm.
|
String |
getStatus()
A string that represents the current key-signing key (KSK) status.
|
String |
getStatusMessage()
The status message provided for the following key-signing key (KSK) statuses:
ACTION_NEEDED or
INTERNAL_FAILURE . |
int |
hashCode() |
void |
setCreatedDate(Date createdDate)
The date when the key-signing key (KSK) was created.
|
void |
setDigestAlgorithmMnemonic(String digestAlgorithmMnemonic)
A string used to represent the delegation signer digest algorithm.
|
void |
setDigestAlgorithmType(Integer digestAlgorithmType)
An integer used to represent the delegation signer digest algorithm.
|
void |
setDigestValue(String digestValue)
A cryptographic digest of a DNSKEY resource record (RR).
|
void |
setDNSKEYRecord(String dNSKEYRecord)
A string that represents a DNSKEY record.
|
void |
setDSRecord(String dSRecord)
A string that represents a delegation signer (DS) record.
|
void |
setFlag(Integer flag)
An integer that specifies how the key is used.
|
void |
setKeyTag(Integer keyTag)
An integer used to identify the DNSSEC record for the domain name.
|
void |
setKmsArn(String kmsArn)
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
|
void |
setLastModifiedDate(Date lastModifiedDate)
The last time that the key-signing key (KSK) was changed.
|
void |
setName(String name)
A string used to identify a key-signing key (KSK).
|
void |
setPublicKey(String publicKey)
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
|
void |
setSigningAlgorithmMnemonic(String signingAlgorithmMnemonic)
A string used to represent the signing algorithm.
|
void |
setSigningAlgorithmType(Integer signingAlgorithmType)
An integer used to represent the signing algorithm.
|
void |
setStatus(String status)
A string that represents the current key-signing key (KSK) status.
|
void |
setStatusMessage(String statusMessage)
The status message provided for the following key-signing key (KSK) statuses:
ACTION_NEEDED or
INTERNAL_FAILURE . |
String |
toString()
Returns a string representation of this object.
|
KeySigningKey |
withCreatedDate(Date createdDate)
The date when the key-signing key (KSK) was created.
|
KeySigningKey |
withDigestAlgorithmMnemonic(String digestAlgorithmMnemonic)
A string used to represent the delegation signer digest algorithm.
|
KeySigningKey |
withDigestAlgorithmType(Integer digestAlgorithmType)
An integer used to represent the delegation signer digest algorithm.
|
KeySigningKey |
withDigestValue(String digestValue)
A cryptographic digest of a DNSKEY resource record (RR).
|
KeySigningKey |
withDNSKEYRecord(String dNSKEYRecord)
A string that represents a DNSKEY record.
|
KeySigningKey |
withDSRecord(String dSRecord)
A string that represents a delegation signer (DS) record.
|
KeySigningKey |
withFlag(Integer flag)
An integer that specifies how the key is used.
|
KeySigningKey |
withKeyTag(Integer keyTag)
An integer used to identify the DNSSEC record for the domain name.
|
KeySigningKey |
withKmsArn(String kmsArn)
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).
|
KeySigningKey |
withLastModifiedDate(Date lastModifiedDate)
The last time that the key-signing key (KSK) was changed.
|
KeySigningKey |
withName(String name)
A string used to identify a key-signing key (KSK).
|
KeySigningKey |
withPublicKey(String publicKey)
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
|
KeySigningKey |
withSigningAlgorithmMnemonic(String signingAlgorithmMnemonic)
A string used to represent the signing algorithm.
|
KeySigningKey |
withSigningAlgorithmType(Integer signingAlgorithmType)
An integer used to represent the signing algorithm.
|
KeySigningKey |
withStatus(String status)
A string that represents the current key-signing key (KSK) status.
|
KeySigningKey |
withStatusMessage(String statusMessage)
The status message provided for the following key-signing key (KSK) statuses:
ACTION_NEEDED or
INTERNAL_FAILURE . |
public void setName(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.
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.public String getName()
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.
Name
can include numbers, letters, and
underscores (_). Name
must be unique for each key-signing key in the same hosted zone.public KeySigningKey withName(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.
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.public void setKmsArn(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:
Enabled
ECC_NIST_P256
Sign and verify
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.
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:
Enabled
ECC_NIST_P256
Sign and verify
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.
public String getKmsArn()
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:
Enabled
ECC_NIST_P256
Sign and verify
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.
KmsArn
must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
Enabled
ECC_NIST_P256
Sign and verify
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.
public KeySigningKey withKmsArn(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:
Enabled
ECC_NIST_P256
Sign and verify
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.
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:
Enabled
ECC_NIST_P256
Sign and verify
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.
public void setFlag(Integer flag)
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
flag
- An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.public Integer getFlag()
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
public KeySigningKey withFlag(Integer flag)
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
flag
- An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.public void setSigningAlgorithmMnemonic(String signingAlgorithmMnemonic)
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
signingAlgorithmMnemonic
- A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.public String getSigningAlgorithmMnemonic()
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
public KeySigningKey withSigningAlgorithmMnemonic(String signingAlgorithmMnemonic)
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
signingAlgorithmMnemonic
- A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.public void setSigningAlgorithmType(Integer signingAlgorithmType)
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
signingAlgorithmType
- An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.public Integer getSigningAlgorithmType()
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
public KeySigningKey withSigningAlgorithmType(Integer signingAlgorithmType)
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
signingAlgorithmType
- An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.public void setDigestAlgorithmMnemonic(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.
digestAlgorithmMnemonic
- A string used to represent the delegation signer digest algorithm. This value must follow the guidelines
provided by RFC-8624 Section 3.3.public String getDigestAlgorithmMnemonic()
A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
public KeySigningKey withDigestAlgorithmMnemonic(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.
digestAlgorithmMnemonic
- A string used to represent the delegation signer digest algorithm. This value must follow the guidelines
provided by RFC-8624 Section 3.3.public void setDigestAlgorithmType(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.
digestAlgorithmType
- An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines
provided by RFC-8624 Section 3.3.public Integer getDigestAlgorithmType()
An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
public KeySigningKey withDigestAlgorithmType(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.
digestAlgorithmType
- An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines
provided by RFC-8624 Section 3.3.public void setKeyTag(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.
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.public Integer getKeyTag()
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.
public KeySigningKey withKeyTag(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.
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.public void setDigestValue(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.
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.public String getDigestValue()
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.
public KeySigningKey withDigestValue(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.
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.public void setPublicKey(String publicKey)
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
publicKey
- The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.public String getPublicKey()
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
public KeySigningKey withPublicKey(String publicKey)
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
publicKey
- The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.public void setDSRecord(String dSRecord)
A string that represents a delegation signer (DS) record.
dSRecord
- A string that represents a delegation signer (DS) record.public String getDSRecord()
A string that represents a delegation signer (DS) record.
public KeySigningKey withDSRecord(String dSRecord)
A string that represents a delegation signer (DS) record.
dSRecord
- A string that represents a delegation signer (DS) record.public void setDNSKEYRecord(String dNSKEYRecord)
A string that represents a DNSKEY record.
dNSKEYRecord
- A string that represents a DNSKEY record.public String getDNSKEYRecord()
A string that represents a DNSKEY record.
public KeySigningKey withDNSKEYRecord(String dNSKEYRecord)
A string that represents a DNSKEY record.
dNSKEYRecord
- A string that represents a DNSKEY record.public void setStatus(String status)
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
status
- A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
public String getStatus()
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
public KeySigningKey withStatus(String status)
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
status
- A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
The KSK is being used for signing.
The KSK is not being used for signing.
The KSK is in the process of being deleted.
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.
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.
public void setStatusMessage(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.
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.public String getStatusMessage()
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.
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.public KeySigningKey withStatusMessage(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.
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.public void setCreatedDate(Date createdDate)
The date when the key-signing key (KSK) was created.
createdDate
- The date when the key-signing key (KSK) was created.public Date getCreatedDate()
The date when the key-signing key (KSK) was created.
public KeySigningKey withCreatedDate(Date createdDate)
The date when the key-signing key (KSK) was created.
createdDate
- The date when the key-signing key (KSK) was created.public void setLastModifiedDate(Date lastModifiedDate)
The last time that the key-signing key (KSK) was changed.
lastModifiedDate
- The last time that the key-signing key (KSK) was changed.public Date getLastModifiedDate()
The last time that the key-signing key (KSK) was changed.
public KeySigningKey withLastModifiedDate(Date lastModifiedDate)
The last time that the key-signing key (KSK) was changed.
lastModifiedDate
- The last time that the key-signing key (KSK) was changed.public String toString()
toString
in class Object
Object.toString()
public KeySigningKey clone()