Class CreateCustomKeyStoreRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCustomKeyStoreRequest.Builder,
CreateCustomKeyStoreRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Identifies the CloudHSM cluster for an CloudHSM key store.final String
Specifies a friendly name for the custom key store.final CustomKeyStoreType
Specifies the type of custom key store.final String
Specifies the type of custom key store.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
Specifies thekmsuser
password for an CloudHSM key store.static Class
<? extends CreateCustomKeyStoreRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Specifies the certificate for an CloudHSM key store.Specifies an authentication credential for the external key store proxy (XKS proxy).final XksProxyConnectivityType
Indicates how KMS communicates with the external key store proxy.final String
Indicates how KMS communicates with the external key store proxy.final String
Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy).final String
Specifies the base path to the proxy APIs for this external key store.final String
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).Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
customKeyStoreName
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.
- Returns:
- 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.
-
cloudHsmClusterId
Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with
CustomKeyStoreType
ofAWS_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.
- Returns:
- Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key
stores with
CustomKeyStoreType
ofAWS_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.
-
trustAnchorCertificate
Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a
CustomKeyStoreType
ofAWS_CLOUDHSM
.Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the
customerCA.crt
file that you created when you initialized the cluster.- Returns:
- Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores
with a
CustomKeyStoreType
ofAWS_CLOUDHSM
.Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the
customerCA.crt
file that you created when you initialized the cluster.
-
keyStorePassword
Specifies the
kmsuser
password for an CloudHSM key store. This parameter is required for custom key stores with aCustomKeyStoreType
ofAWS_CLOUDHSM
.Enter the password of the
kmsuser
crypto 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
kmsuser
account password; it does not change the password in the CloudHSM cluster.- Returns:
- Specifies the
kmsuser
password for an CloudHSM key store. This parameter is required for custom key stores with aCustomKeyStoreType
ofAWS_CLOUDHSM
.Enter the password of the
kmsuser
crypto 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
kmsuser
account password; it does not change the password in the CloudHSM cluster.
-
customKeyStoreType
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.If the service returns an enum value that is not available in the current SDK version,
customKeyStoreType
will returnCustomKeyStoreType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomKeyStoreTypeAsString()
.- Returns:
- 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. - See Also:
-
customKeyStoreTypeAsString
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.If the service returns an enum value that is not available in the current SDK version,
customKeyStoreType
will returnCustomKeyStoreType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcustomKeyStoreTypeAsString()
.- Returns:
- 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. - See Also:
-
xksProxyUriEndpoint
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
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the
XksProxyUriEndpoint
value.For external key stores with
XksProxyConnectivity
value ofVPC_ENDPOINT_SERVICE
, specifyhttps://
followed by the private DNS name of the VPC endpoint service.For external key stores with
PUBLIC_ENDPOINT
connectivity, 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_SERVICE
connectivity, 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
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region. -
An external key store with
PUBLIC_ENDPOINT
connectivity cannot use the sameXksProxyUriEndpoint
value as an external key store withVPC_ENDPOINT_SERVICE
connectivity in this Amazon Web Services Region. -
Each external key store with
VPC_ENDPOINT_SERVICE
connectivity must have its own private DNS name. TheXksProxyUriEndpoint
value for external key stores withVPC_ENDPOINT_SERVICE
connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.
- Returns:
- 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
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the
XksProxyUriEndpoint
value.For external key stores with
XksProxyConnectivity
value ofVPC_ENDPOINT_SERVICE
, specifyhttps://
followed by the private DNS name of the VPC endpoint service.For external key stores with
PUBLIC_ENDPOINT
connectivity, 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_SERVICE
connectivity, 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
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region. -
An external key store with
PUBLIC_ENDPOINT
connectivity cannot use the sameXksProxyUriEndpoint
value as an external key store withVPC_ENDPOINT_SERVICE
connectivity in this Amazon Web Services Region. -
Each external key store with
VPC_ENDPOINT_SERVICE
connectivity must have its own private DNS name. TheXksProxyUriEndpoint
value for external key stores withVPC_ENDPOINT_SERVICE
connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.
-
-
-
xksProxyUriPath
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
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The value must start with
/
and must end with/kms/xks/v1
wherev1
represents 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
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region.
- Returns:
- 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
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The value must start with
/
and must end with/kms/xks/v1
wherev1
represents 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
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region.
-
-
-
xksProxyVpcEndpointServiceName
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
CustomKeyStoreType
isEXTERNAL_KEY_STORE
and the value ofXksProxyConnectivity
isVPC_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_SERVICE
connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.
- Returns:
- 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
CustomKeyStoreType
isEXTERNAL_KEY_STORE
and the value ofXksProxyConnectivity
isVPC_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_SERVICE
connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.
-
-
-
xksProxyAuthenticationCredential
Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required for all custom key stores with a
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The
XksProxyAuthenticationCredential
has 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.
- Returns:
- Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is
required for all custom key stores with a
CustomKeyStoreType
ofEXTERNAL_KEY_STORE
.The
XksProxyAuthenticationCredential
has 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.
-
xksProxyConnectivity
Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a
CustomKeyStoreType
ofEXTERNAL_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.
If the service returns an enum value that is not available in the current SDK version,
xksProxyConnectivity
will returnXksProxyConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromxksProxyConnectivityAsString()
.- Returns:
- Indicates how KMS communicates with the external key store proxy. This parameter is required for custom
key stores with a
CustomKeyStoreType
ofEXTERNAL_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.
- See Also:
-
xksProxyConnectivityAsString
Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a
CustomKeyStoreType
ofEXTERNAL_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.
If the service returns an enum value that is not available in the current SDK version,
xksProxyConnectivity
will returnXksProxyConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromxksProxyConnectivityAsString()
.- Returns:
- Indicates how KMS communicates with the external key store proxy. This parameter is required for custom
key stores with a
CustomKeyStoreType
ofEXTERNAL_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.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateCustomKeyStoreRequest.Builder,
CreateCustomKeyStoreRequest> - Specified by:
toBuilder
in classKmsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-