class KeySigningKey (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Route53.KeySigningKey |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsroute53#KeySigningKey |
Java | software.amazon.awscdk.services.route53.KeySigningKey |
Python | aws_cdk.aws_route53.KeySigningKey |
TypeScript (source) | aws-cdk-lib » aws_route53 » KeySigningKey |
Implements
IConstruct
, IDependable
, IResource
, IKey
A Key Signing Key for a Route 53 Hosted Zone.
Example
declare const hostedZone: route53.HostedZone;
declare const kmsKey: kms.Key;
new route53.KeySigningKey(this, 'KeySigningKey', {
hostedZone,
kmsKey,
keySigningKeyName: 'ksk',
status: route53.KeySigningKeyStatus.ACTIVE,
});
Initializer
new KeySigningKey(scope: Construct, id: string, props: KeySigningKeyProps)
Parameters
- scope
Construct
- id
string
- props
Key
Signing Key Props
Construct Props
Name | Type | Description |
---|---|---|
hosted | IHosted | The hosted zone that this key will be used to sign. |
kms | IKey | The customer-managed KMS key that that will be used to sign the records. |
key | string | The name for the key signing key. |
status? | Key | The status of the key signing key. |
hostedZone
Type:
IHosted
The hosted zone that this key will be used to sign.
kmsKey
Type:
IKey
The customer-managed KMS key that that will be used to sign the records.
The KMS Key must be unique for each KSK within a hosted zone. Additionally, the KMS key must be an asymetric customer-managed key using the ECC_NIST_P256 algorithm.
keySigningKeyName?
Type:
string
(optional, default: an autogenerated name)
The name for the key signing key.
This name must be unique within a hosted zone.
status?
Type:
Key
(optional, default: ACTIVE)
The status of the key signing key.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
hosted | IHosted | The hosted zone that the key signing key signs. |
key | string | The ID of the key signing key, derived from the hosted zone ID and its name. |
key | string | The name of the key signing key. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
hostedZone
Type:
IHosted
The hosted zone that the key signing key signs.
keySigningKeyId
Type:
string
The ID of the key signing key, derived from the hosted zone ID and its name.
keySigningKeyName
Type:
string
The name of the key signing key.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports a key signing key from its attributes. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
KeySigningKeyAttributes(scope, id, attrs)
static frompublic static fromKeySigningKeyAttributes(scope: Construct, id: string, attrs: KeySigningKeyAttributes): IKeySigningKey
Parameters
- scope
Construct
- id
string
- attrs
Key
Signing Key Attributes
Returns
Imports a key signing key from its attributes.