Package software.amazon.awscdk.services.route53

Class CfnKeySigningKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.route53.CfnKeySigningKey

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:05.085Z")
@Stability(Stable)
public class CfnKeySigningKey
extends CfnResource
implements IInspectable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnKeySigningKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKeySigningKey(software.amazon.jsii.JsiiObjectRef objRef)
	CfnKeySigningKey(software.constructs.Construct scope, String id, CfnKeySigningKeyProps props)

Method Summary

Modifier and Type	Method	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.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnKeySigningKey

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

CfnKeySigningKey

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

CfnKeySigningKey

@Stability(Stable)
public CfnKeySigningKey(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnKeySigningKeyProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(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(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHostedZoneId

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

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

setHostedZoneId

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

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

getKeyManagementServiceArn

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

setKeyManagementServiceArn

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

getName

@Stability(Stable)
@NotNull
public String getName()

A string used to identify a key-signing key (KSK).

setName

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

A string used to identify a key-signing key (KSK).

getStatus

@Stability(Stable)
@NotNull
public String getStatus()

A string that represents the current key-signing key (KSK) status.

setStatus

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

A string that represents the current key-signing key (KSK) status.