Interface CfnKeySigningKeyProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnKeySigningKeyProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:42.937Z")
@Stability(Stable)
public interface CfnKeySigningKeyProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnKeySigningKey
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.route53.*; CfnKeySigningKeyProps cfnKeySigningKeyProps = CfnKeySigningKeyProps.builder() .hostedZoneId("hostedZoneId") .keyManagementServiceArn("keyManagementServiceArn") .name("name") .status("status") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnKeySigningKeyProps
static final class
An implementation forCfnKeySigningKeyProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The unique string (ID) that is used to identify a hosted zone.The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ).getName()
A string used to identify a key-signing key (KSK).A string that represents the current key-signing key (KSK) status.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHostedZoneId
The unique string (ID) that is used to identify a hosted zone.For example:
Z00001111A1ABCaaABC11
. -
getKeyManagementServiceArn
The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ).The
KeyManagementServiceArn
must be unique for each key-signing key (KSK) in a single hosted zone. For example:arn:aws:kms:us-east-1:111122223333:key/111a2222-a11b-1ab1-2ab2-1ab21a2b3a111
. -
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. -
getStatus
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.
-
builder
- Returns:
- a
CfnKeySigningKeyProps.Builder
ofCfnKeySigningKeyProps
-