Route53 / Client / create_key_signing_key

create_key_signing_key#

Route53.Client.create_key_signing_key(**kwargs)#

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

Request Syntax

response = client.create_key_signing_key(
    CallerReference='string',
    HostedZoneId='string',
    KeyManagementServiceArn='string',
    Name='string',
    Status='string'
)

Parameters:

CallerReference (string) –
[REQUIRED]

A unique string that identifies the request.
HostedZoneId (string) –
[REQUIRED]

The unique string (ID) used to identify a hosted zone.
KeyManagementServiceArn (string) –
[REQUIRED]

The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.

You must configure the customer managed customer managed key as follows:

Status

Enabled

Key spec

ECC_NIST_P256

Key usage

Sign and verify

Key policy

The key policy must give permission for the following actions:
- DescribeKey
- GetPublicKey
- Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
- "Service": "dnssec-route53.amazonaws.com"
For more information about working with a customer managed key in KMS, see Key Management Service concepts.
Name (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.
Status (string) –
[REQUIRED]

A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE.

Return type:

dict

Returns:

Response Syntax

{
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    },
    'KeySigningKey': {
        'Name': 'string',
        'KmsArn': 'string',
        'Flag': 123,
        'SigningAlgorithmMnemonic': 'string',
        'SigningAlgorithmType': 123,
        'DigestAlgorithmMnemonic': 'string',
        'DigestAlgorithmType': 123,
        'KeyTag': 123,
        'DigestValue': 'string',
        'PublicKey': 'string',
        'DSRecord': 'string',
        'DNSKEYRecord': 'string',
        'Status': 'string',
        'StatusMessage': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'LastModifiedDate': datetime(2015, 1, 1)
    },
    'Location': 'string'
}

Response Structure

(dict) –
- ChangeInfo (dict) –
  
  A complex type that describes change information about changes made to your hosted zone.
  - Id (string) –
    
    This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
  - Status (string) –
    
    The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
  - SubmittedAt (datetime) –
    
    The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.
  - Comment (string) –
    
    A comment you can provide.
- KeySigningKey (dict) –
  
  The key-signing key (KSK) that the request creates.
  - Name (string) –
    
    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.
  - KmsArn (string) –
    
    The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
    
    You must configure the customer managed key as follows:
    
    Status
    
    Enabled
    
    Key spec
    
    ECC_NIST_P256
    
    Key usage
    
    Sign and verify
    
    Key policy
    
    The key policy must give permission for the following actions:
    - DescribeKey
    - GetPublicKey
    - Sign
    The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
    - "Service": "dnssec-route53.amazonaws.com"
    For more information about working with the customer managed key in KMS, see Key Management Service concepts.
  - Flag (integer) –
    
    An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
  - SigningAlgorithmMnemonic (string) –
    
    A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
  - SigningAlgorithmType (integer) –
    
    An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
  - DigestAlgorithmMnemonic (string) –
    
    A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
  - DigestAlgorithmType (integer) –
    
    An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
  - KeyTag (integer) –
    
    An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.
  - DigestValue (string) –
    
    A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
  - PublicKey (string) –
    
    The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
  - DSRecord (string) –
    
    A string that represents a delegation signer (DS) record.
  - DNSKEYRecord (string) –
    
    A string that represents a DNSKEY record.
  - Status (string) –
    
    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.
  - StatusMessage (string) –
    
    The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.
  - CreatedDate (datetime) –
    
    The date when the key-signing key (KSK) was created.
  - LastModifiedDate (datetime) –
    
    The last time that the key-signing key (KSK) was changed.
- Location (string) –
  
  The unique URL representing the new key-signing key (KSK).

Exceptions

Route53.Client.exceptions.NoSuchHostedZone
Route53.Client.exceptions.InvalidArgument
Route53.Client.exceptions.InvalidInput
Route53.Client.exceptions.InvalidKMSArn
Route53.Client.exceptions.InvalidKeySigningKeyStatus
Route53.Client.exceptions.InvalidSigningStatus
Route53.Client.exceptions.InvalidKeySigningKeyName
Route53.Client.exceptions.KeySigningKeyAlreadyExists
Route53.Client.exceptions.TooManyKeySigningKeys
Route53.Client.exceptions.ConcurrentModification