software.amazon.awscdk.services.route53

Class CfnKeySigningKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.route53.CfnKeySigningKey

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.732Z")
 @Stability(value=Stable)
public class CfnKeySigningKey
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53::KeySigningKey`.

The AWS::Route53::KeySigningKey resource creates a new key-signing key (KSK) in a hosted zone. The hosted zone ID is passed as a parameter in the KSK properties. You can specify the properties of this KSK using the Name , Status , and KeyManagementServiceArn properties of the resource.

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.*;
 CfnKeySigningKey cfnKeySigningKey = CfnKeySigningKey.Builder.create(this, "MyCfnKeySigningKey")
         .hostedZoneId("hostedZoneId")
         .keyManagementServiceArn("keyManagementServiceArn")
         .name("name")
         .status("status")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnKeySigningKey.Builder A fluent builder for CfnKeySigningKey.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnKeySigningKey(Construct scope, String id, CfnKeySigningKeyProps props) Create a new `AWS::Route53::KeySigningKey`.
protected	CfnKeySigningKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKeySigningKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setHostedZoneId(String value) The unique string (ID) that is used to identify a hosted zone.
void	setKeyManagementServiceArn(String value) The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service ( AWS KMS ).
void	setName(String value) A string used to identify a key-signing key (KSK).
void	setStatus(String value) A string that represents the current key-signing key (KSK) status.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnKeySigningKey

protected CfnKeySigningKey(software.amazon.jsii.JsiiObjectRef objRef)

CfnKeySigningKey

protected CfnKeySigningKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnKeySigningKey

@Stability(value=Stable)
public CfnKeySigningKey(@NotNull
                                                 Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnKeySigningKeyProps props)

Create a new `AWS::Route53::KeySigningKey`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getHostedZoneId()

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

For example: Z00001111A1ABCaaABC11 .

setHostedZoneId

@Stability(value=Stable)
public void setHostedZoneId(@NotNull
                                                     String value)

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

For example: Z00001111A1ABCaaABC11 .

getKeyManagementServiceArn

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

setKeyManagementServiceArn

@Stability(value=Stable)
public void setKeyManagementServiceArn(@NotNull
                                                                String value)

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

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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

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

setStatus

@Stability(value=Stable)
public void setStatus(@NotNull
                                               String value)

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.