Skip to content
v2.278.0

CfnKeySigningKeyProps Struct ​

Properties for defining a CfnKeySigningKey.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_route53 as route53 } from 'aws-cdk-lib';
const cfnKeySigningKeyProps: route53.CfnKeySigningKeyProps = {
  hostedZoneId: 'hostedZoneId',
  keyManagementServiceArn: 'keyManagementServiceArn',
  name: 'name',
  status: 'status',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53 as route53

cfn_key_signing_key_props = route53.CfnKeySigningKeyProps(
    hosted_zone_id="hostedZoneId",
    key_management_service_arn="keyManagementServiceArn",
    name="name",
    status="status"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Route53;

var cfnKeySigningKeyProps = new CfnKeySigningKeyProps {
    HostedZoneId = "hostedZoneId",
    KeyManagementServiceArn = "keyManagementServiceArn",
    Name = "name",
    Status = "status"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnKeySigningKeyProps := &CfnKeySigningKeyProps{
	HostedZoneId: jsii.String("hostedZoneId"),
	KeyManagementServiceArn: jsii.String("keyManagementServiceArn"),
	Name: jsii.String("name"),
	Status: jsii.String("status"),
}

Properties ​

hostedZoneIdstringhosted_zone_idstrhostedZoneIdStringHostedZoneIdstringHostedZoneId*string required #
The unique string (ID) that is used to identify a hosted zone.

For example: Z00001111A1ABCaaABC11 .

keyManagementServiceArnstringkey_management_service_arnstrkeyManagementServiceArnStringKeyManagementServiceArnstringKeyManagementServiceArn*string required #
The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS ).

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 .

namestringnamestrnameStringNamestringName*string required #
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.

statusstringstatusstrstatusStringStatusstringStatus*string required #
A string that represents the current key-signing key (KSK) status.
notes

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.