create_custom_key_store
¶
create_custom_key_store(
custom_key_store_name: CustomKeyStoreNameType,
*,
config_overrides: Optional[KMSClientConfig] = None,
cloud_hsm_cluster_id: Optional[CloudHsmClusterIdType] = None,
trust_anchor_certificate: Optional[TrustAnchorCertificateType] = None,
key_store_password: Optional[KeyStorePasswordType] = None,
custom_key_store_type: Optional[CustomKeyStoreType] = None,
xks_proxy_uri_endpoint: Optional[XksProxyUriEndpointType] = None,
xks_proxy_uri_path: Optional[XksProxyUriPathType] = None,
xks_proxy_vpc_endpoint_service_name: Optional[
XksProxyVpcEndpointServiceNameType
] = None,
xks_proxy_vpc_endpoint_service_owner: Optional[AccountIdType] = None,
xks_proxy_authentication_credential: Optional[
XksProxyAuthenticationCredentialType
] = None,
xks_proxy_connectivity: Optional[XksProxyConnectivityType] = None,
) -> CreateCustomKeyStoreResponse
Creates a custom key store backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key store proxy and external key manager outside of Amazon Web Services.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
Before you create the custom key store, the required elements must be in place and operational. We recommend that you use the test tools that KMS provides to verify the configuration your external key store proxy. For details about the required elements and verification tests, see Assemble the prerequisites (for CloudHSM key stores) or Assemble the prerequisites (for external key stores) in the Key Management Service Developer Guide.
To create a custom key store, use the following parameters.
-
To create an CloudHSM key store, specify the
CustomKeyStoreName,CloudHsmClusterId,KeyStorePassword, andTrustAnchorCertificate. TheCustomKeyStoreTypeparameter is optional for CloudHSM key stores. If you include it, set it to the default value,AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM key store in the Key Management Service Developer Guide. -
To create an external key store, specify the
CustomKeyStoreNameand aCustomKeyStoreTypeofEXTERNAL_KEY_STORE. Also, specify values forXksProxyConnectivity,XksProxyAuthenticationCredential,XksProxyUriEndpoint, andXksProxyUriPath. If yourXksProxyConnectivityvalue isVPC_ENDPOINT_SERVICE, specify theXksProxyVpcEndpointServiceNameparameter. For help with failures, see Troubleshooting an external key store in the Key Management Service Developer Guide.
For external key stores:
Some external key managers provide a simpler method for creating an external key store. For details, see your external key manager documentation.
When creating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot use a proxy configuration with the CreateCustomKeyStore operation. However, you can use the values in the file to help you determine the correct values for the CreateCustomKeyStore parameters.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect a new CloudHSM key store to its CloudHSM cluster, or to connect a new external key store to the external key store proxy for your external key manager. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:CreateCustomKeyStore (IAM policy).
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
-
custom_key_store_name(CustomKeyStoreNameType) –Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
-
cloud_hsm_cluster_id(Optional[CloudHsmClusterIdType], default:None) –Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with
CustomKeyStoreTypeofAWS_CLOUDHSM.Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
-
trust_anchor_certificate(Optional[TrustAnchorCertificateType], default:None) –Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a
CustomKeyStoreTypeofAWS_CLOUDHSM.Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the
customerCA.crtfile that you created when you initialized the cluster. -
key_store_password(Optional[KeyStorePasswordType], default:None) –Specifies the
kmsuserpassword for an CloudHSM key store. This parameter is required for custom key stores with aCustomKeyStoreTypeofAWS_CLOUDHSM.Enter the password of the
kmsusercrypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells KMS the
kmsuseraccount password; it does not change the password in the CloudHSM cluster. -
custom_key_store_type(Optional[CustomKeyStoreType], default:None) –Specifies the type of custom key store. The default value is
AWS_CLOUDHSM.For a custom key store backed by an CloudHSM cluster, omit the parameter or enter
AWS_CLOUDHSM. For a custom key store backed by an external key manager outside of Amazon Web Services, enterEXTERNAL_KEY_STORE. You cannot change this property after the key store is created. -
xks_proxy_uri_endpoint(Optional[XksProxyUriEndpointType], default:None) –Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy). This parameter is required for custom key stores with a
CustomKeyStoreTypeofEXTERNAL_KEY_STORE.The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the
XksProxyUriEndpointvalue.For external key stores with
XksProxyConnectivityvalue ofVPC_ENDPOINT_SERVICE, specifyhttps://followed by the private DNS name of the VPC endpoint service.For external key stores with
PUBLIC_ENDPOINTconnectivity, this endpoint must be reachable before you create the custom key store. KMS connects to the external key store proxy while creating the custom key store. For external key stores withVPC_ENDPOINT_SERVICEconnectivity, KMS connects when you call the ConnectCustomKeyStore operation.The value of this parameter must begin with
https://. The remainder can contain upper and lower case letters (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (/and\) are not permitted.Uniqueness requirements:
-
The combined
XksProxyUriEndpointandXksProxyUriPathvalues must be unique in the Amazon Web Services account and Region. -
An external key store with
PUBLIC_ENDPOINTconnectivity cannot use the sameXksProxyUriEndpointvalue as an external key store withVPC_ENDPOINT_SERVICEconnectivity in this Amazon Web Services Region. -
Each external key store with
VPC_ENDPOINT_SERVICEconnectivity must have its own private DNS name. TheXksProxyUriEndpointvalue for external key stores withVPC_ENDPOINT_SERVICEconnectivity (private DNS name) must be unique in the Amazon Web Services account and Region.
-
-
xks_proxy_uri_path(Optional[XksProxyUriPathType], default:None) –Specifies the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. This parameter is required for all custom key stores with a
CustomKeyStoreTypeofEXTERNAL_KEY_STORE.The value must start with
/and must end with/kms/xks/v1wherev1represents the version of the KMS external key store proxy API. This path can include an optional prefix between the required elements such as/prefix/kms/xks/v1.Uniqueness requirements:
-
The combined
XksProxyUriEndpointandXksProxyUriPathvalues must be unique in the Amazon Web Services account and Region.
-
-
xks_proxy_vpc_endpoint_service_name(Optional[XksProxyVpcEndpointServiceNameType], default:None) –Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). This parameter is required when the value of
CustomKeyStoreTypeisEXTERNAL_KEY_STOREand the value ofXksProxyConnectivityisVPC_ENDPOINT_SERVICE.The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.
Uniqueness requirements:
-
External key stores with
VPC_ENDPOINT_SERVICEconnectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.
-
-
xks_proxy_vpc_endpoint_service_owner(Optional[AccountIdType], default:None) –Specifies the Amazon Web Services account ID that owns the Amazon VPC service endpoint for the interface that is used to communicate with your external key store proxy (XKS proxy). This parameter is optional. If not provided, the Amazon Web Services account ID calling the action will be used.
-
xks_proxy_authentication_credential(Optional[XksProxyAuthenticationCredentialType], default:None) –Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required for all custom key stores with a
CustomKeyStoreTypeofEXTERNAL_KEY_STORE.The
XksProxyAuthenticationCredentialhas two required elements:RawSecretAccessKey, a secret key, andAccessKeyId, a unique identifier for theRawSecretAccessKey. For character requirements, see XksProxyAuthenticationCredentialType.KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.
This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.
-
xks_proxy_connectivity(Optional[XksProxyConnectivityType], default:None) –Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a
CustomKeyStoreTypeofEXTERNAL_KEY_STORE.If the external key store proxy uses a public endpoint, specify
PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC endpoint service for communication with KMS, specifyVPC_ENDPOINT_SERVICE. For help making this choice, see Choosing a connectivity option in the Key Management Service Developer Guide.An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.
Raises:
-
CloudHsmClusterInUseException–The request was rejected because the specified CloudHSM cluster is already associated with an CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the account. Each CloudHSM key store in the account must be associated with a different CloudHSM cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
-
CloudHsmClusterInvalidConfigurationException–The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.
-
The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-
-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation. -
The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the CloudHSM must contain at least one active HSM.
For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the CloudHSM User Guide .
-
-
CloudHsmClusterNotActiveException–The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.
-
CloudHsmClusterNotFoundException–The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
-
CustomKeyStoreNameInUseException–The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
-
IncorrectTrustAnchorException–The request was rejected because the trust anchor certificate in the request to create an CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.
When you initialize the CloudHSM cluster, you create the trust anchor certificate and save it in the
customerCA.crtfile. -
KMSInternalException–The request was rejected because an internal exception occurred. The request can be retried.
-
LimitExceededException–The request was rejected because a length constraint or quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
-
XksProxyIncorrectAuthenticationCredentialException–The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.
-
XksProxyInvalidConfigurationException–The request was rejected because the external key store proxy is not configured correctly. To identify the cause, see the error message that accompanies the exception.
-
XksProxyInvalidResponseException–KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.
-
XksProxyUriEndpointInUseException–The request was rejected because the
XksProxyUriEndpointis already associated with another external key store in this Amazon Web Services Region. To identify the cause, see the error message that accompanies the exception. -
XksProxyUriInUseException–The request was rejected because the concatenation of the
XksProxyUriEndpointandXksProxyUriPathis already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy API address. -
XksProxyUriUnreachableException–KMS was unable to reach the specified
XksProxyUriPath. The path must be reachable before you create the external key store or update its settings.This exception is also thrown when the external key store proxy response to a
GetHealthStatusrequest indicates that all external key manager instances are unavailable. -
XksProxyVpcEndpointServiceInUseException–The request was rejected because the specified Amazon VPC endpoint service is already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a different Amazon VPC endpoint service.
-
XksProxyVpcEndpointServiceInvalidConfigurationException–The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store. To identify the cause, see the error message that accompanies the exception and review the requirements for Amazon VPC endpoint service connectivity for an external key store.
-
XksProxyVpcEndpointServiceNotFoundException–The request was rejected because KMS could not find the specified VPC endpoint service. Use DescribeCustomKeyStores to verify the VPC endpoint service name for the external key store. Also, confirm that the
Allow principalslist for the VPC endpoint service includes the KMS service principal for the Region, such ascks.kms.us-east-1.amazonaws.com. -
UnknownServiceError–The service returned an error code this client does not model.
Examples:
To create an AWS CloudHSM key store This example creates a custom key store that is associated with an AWS CloudHSM cluster.
>>> client.create_custom_key_store(custom_key_store_name='ExampleKeyStore', cloud_hsm_cluster_id='cluster-234abcdefABC', trust_anchor_certificate='<certificate-goes-here>', key_store_password='kmsPswd')
Source code in docs_src/capo_kms/_services/kms.py
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | |