Package software.amazon.awscdk.services.route53

Interface CfnKeySigningKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKeySigningKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:22.746Z")
@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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKeySigningKeyProps.Builder	A builder for CfnKeySigningKeyProps
static final class	CfnKeySigningKeyProps.Jsii$Proxy	An implementation for CfnKeySigningKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnKeySigningKeyProps.Builder	builder()
String	getHostedZoneId()	The unique string (ID) that is used to identify a hosted zone.
String	getKeyManagementServiceArn()	The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ).
String	getName()	A string used to identify a key-signing key (KSK).
String	getStatus()	A string that represents the current key-signing key (KSK) status.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHostedZoneId

@Stability(Stable)
@NotNull
String getHostedZoneId()

The unique string (ID) that is used to identify a hosted zone.

For example: Z00001111A1ABCaaABC11 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-hostedzoneid

getKeyManagementServiceArn

@Stability(Stable)
@NotNull
String 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-keymanagementservicearn

getName

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-name

getStatus

@Stability(Stable)
@NotNull
String 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-keysigningkey.html#cfn-route53-keysigningkey-status

builder

@Stability(Stable)
static CfnKeySigningKeyProps.Builder builder()

Returns:

a CfnKeySigningKeyProps.Builder of CfnKeySigningKeyProps