org.apache.inlong.sort.filesystem.shaded.com.amazonaws.services.kms.model.CustomKeyStoresListEntry Maven / Gradle / Ivy
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information about each custom key store in the custom key store list.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomKeyStoresListEntry implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for the custom key store.
*
*/
private String customKeyStoreId;
/**
*
* The user-specified friendly name for the custom key store.
*
*/
private String customKeyStoreName;
/**
*
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*
*/
private String cloudHsmClusterId;
/**
*
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize the
* cluster, you create this certificate and save it in the customerCA.crt file.
*
*/
private String trustAnchorCertificate;
/**
*
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
* having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
* at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
* connection failure, see Troubleshooting a Custom Key
* Store in the Key Management Service Developer Guide.
*
*/
private String connectionState;
/**
*
* Describes the connection error. This field appears in the response only when the ConnectionState is
* FAILED. For help resolving these errors, see How to Fix a
* Connection Failure in Key Management Service Developer Guide.
*
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
* connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
* ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
* user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
* change the kmsuser account password and update the key store password value for the custom key
* store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
* all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
* fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
* process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
* Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
* cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password value for
* the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
* cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
* Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
* out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
* update the key store password value for the custom key store. For help, see How to Log Out and
* Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the custom key
* store.
*
*
*
*/
private String connectionErrorCode;
/**
*
* The date and time when the custom key store was created.
*
*/
private java.util.Date creationDate;
/**
*
* A unique identifier for the custom key store.
*
*
* @param customKeyStoreId
* A unique identifier for the custom key store.
*/
public void setCustomKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
}
/**
*
* A unique identifier for the custom key store.
*
*
* @return A unique identifier for the custom key store.
*/
public String getCustomKeyStoreId() {
return this.customKeyStoreId;
}
/**
*
* A unique identifier for the custom key store.
*
*
* @param customKeyStoreId
* A unique identifier for the custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomKeyStoresListEntry withCustomKeyStoreId(String customKeyStoreId) {
setCustomKeyStoreId(customKeyStoreId);
return this;
}
/**
*
* The user-specified friendly name for the custom key store.
*
*
* @param customKeyStoreName
* The user-specified friendly name for the custom key store.
*/
public void setCustomKeyStoreName(String customKeyStoreName) {
this.customKeyStoreName = customKeyStoreName;
}
/**
*
* The user-specified friendly name for the custom key store.
*
*
* @return The user-specified friendly name for the custom key store.
*/
public String getCustomKeyStoreName() {
return this.customKeyStoreName;
}
/**
*
* The user-specified friendly name for the custom key store.
*
*
* @param customKeyStoreName
* The user-specified friendly name for the custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomKeyStoresListEntry withCustomKeyStoreName(String customKeyStoreName) {
setCustomKeyStoreName(customKeyStoreName);
return this;
}
/**
*
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*
*
* @param cloudHsmClusterId
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*/
public void setCloudHsmClusterId(String cloudHsmClusterId) {
this.cloudHsmClusterId = cloudHsmClusterId;
}
/**
*
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*
*
* @return A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*/
public String getCloudHsmClusterId() {
return this.cloudHsmClusterId;
}
/**
*
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
*
*
* @param cloudHsmClusterId
* A unique identifier for the CloudHSM cluster that is associated with the custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomKeyStoresListEntry withCloudHsmClusterId(String cloudHsmClusterId) {
setCloudHsmClusterId(cloudHsmClusterId);
return this;
}
/**
*
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize the
* cluster, you create this certificate and save it in the customerCA.crt file.
*
*
* @param trustAnchorCertificate
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize
* the cluster, you create this certificate and save it in the customerCA.crt file.
*/
public void setTrustAnchorCertificate(String trustAnchorCertificate) {
this.trustAnchorCertificate = trustAnchorCertificate;
}
/**
*
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize the
* cluster, you create this certificate and save it in the customerCA.crt file.
*
*
* @return The trust anchor certificate of the associated CloudHSM cluster. When you initialize
* the cluster, you create this certificate and save it in the customerCA.crt file.
*/
public String getTrustAnchorCertificate() {
return this.trustAnchorCertificate;
}
/**
*
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize the
* cluster, you create this certificate and save it in the customerCA.crt file.
*
*
* @param trustAnchorCertificate
* The trust anchor certificate of the associated CloudHSM cluster. When you initialize
* the cluster, you create this certificate and save it in the customerCA.crt file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomKeyStoresListEntry withTrustAnchorCertificate(String trustAnchorCertificate) {
setTrustAnchorCertificate(trustAnchorCertificate);
return this;
}
/**
*
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
* having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
* at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
* connection failure, see Troubleshooting a Custom Key
* Store in the Key Management Service Developer Guide.
*
*
* @param connectionState
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you
* are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active
* and contains at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help
* resolving a connection failure, see Troubleshooting a Custom
* Key Store in the Key Management Service Developer Guide.
* @see ConnectionStateType
*/
public void setConnectionState(String connectionState) {
this.connectionState = connectionState;
}
/**
*
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
* having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
* at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
* connection failure, see Troubleshooting a Custom Key
* Store in the Key Management Service Developer Guide.
*
*
* @return Indicates whether the custom key store is connected to its CloudHSM cluster.
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but
* you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is
* active and contains at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help
* resolving a connection failure, see Troubleshooting a Custom
* Key Store in the Key Management Service Developer Guide.
* @see ConnectionStateType
*/
public String getConnectionState() {
return this.connectionState;
}
/**
*
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
* having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
* at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
* connection failure, see Troubleshooting a Custom Key
* Store in the Key Management Service Developer Guide.
*
*
* @param connectionState
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you
* are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active
* and contains at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help
* resolving a connection failure, see Troubleshooting a Custom
* Key Store in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionStateType
*/
public CustomKeyStoresListEntry withConnectionState(String connectionState) {
setConnectionState(connectionState);
return this;
}
/**
*
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
* having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
* at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
* connection failure, see Troubleshooting a Custom Key
* Store in the Key Management Service Developer Guide.
*
*
* @param connectionState
* Indicates whether the custom key store is connected to its CloudHSM cluster.
*
* You can create and use KMS keys in your custom key stores only when its connection state is
* CONNECTED.
*
*
* The value is DISCONNECTED if the key store has never been connected or you use the
* DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you
* are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active
* and contains at least one active HSM.
*
*
* A value of FAILED indicates that an attempt to connect was unsuccessful. The
* ConnectionErrorCode field in the response indicates the cause of the failure. For help
* resolving a connection failure, see Troubleshooting a Custom
* Key Store in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionStateType
*/
public CustomKeyStoresListEntry withConnectionState(ConnectionStateType connectionState) {
this.connectionState = connectionState.toString();
return this;
}
/**
*
* Describes the connection error. This field appears in the response only when the ConnectionState is
* FAILED. For help resolving these errors, see How to Fix a
* Connection Failure in Key Management Service Developer Guide.
*
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
* connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
* ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
* user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
* change the kmsuser account password and update the key store password value for the custom key
* store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
* all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
* fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
* process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
* Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
* cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password value for
* the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
* cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
* Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
* out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
* update the key store password value for the custom key store. For help, see How to Log Out and
* Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the custom key
* store.
*
*
*
*
* @param connectionErrorCode
* Describes the connection error. This field appears in the response only when the
* ConnectionState is FAILED. For help resolving these errors, see How to
* Fix a Connection Failure in Key Management Service Developer Guide.
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active
* HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active
* HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the
* request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to
* connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser
* crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster,
* you must change the kmsuser account password and update the key store password value for the
* custom key store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot
* find all of the subnets in the cluster configuration, attempts to connect the custom key store to the
* CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your
* custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For
* details, see How to
* Fix a Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated
* CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to
* its CloudHSM cluster, you must change the kmsuser account password and update the key store
* password value for the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated
* CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging
* into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the
* kmsuser CU out of the cluster. If you changed the kmsuser password to log into
* the cluster, you must also and update the key store password value for the custom key store. For help, see
* How to
* Log Out and Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the
* custom key store.
*
*
* @see ConnectionErrorCodeType
*/
public void setConnectionErrorCode(String connectionErrorCode) {
this.connectionErrorCode = connectionErrorCode;
}
/**
*
* Describes the connection error. This field appears in the response only when the ConnectionState is
* FAILED. For help resolving these errors, see How to Fix a
* Connection Failure in Key Management Service Developer Guide.
*
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
* connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
* ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
* user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
* change the kmsuser account password and update the key store password value for the custom key
* store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
* all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
* fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
* process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
* Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
* cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password value for
* the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
* cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
* Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
* out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
* update the key store password value for the custom key store. For help, see How to Log Out and
* Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the custom key
* store.
*
*
*
*
* @return Describes the connection error. This field appears in the response only when the
* ConnectionState is FAILED. For help resolving these errors, see How to
* Fix a Connection Failure in Key Management Service Developer Guide.
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active
* HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active
* HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the
* request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying
* to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser
* crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password
* value for the custom key store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot
* find all of the subnets in the cluster configuration, attempts to connect the custom key store to the
* CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with
* your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.)
* For details, see How to
* Fix a Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated
* CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store
* to its CloudHSM cluster, you must change the kmsuser account password and update the key
* store password value for the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated
* CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging
* into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the
* kmsuser CU out of the cluster. If you changed the kmsuser password to log into
* the cluster, you must also and update the key store password value for the custom key store. For help,
* see How
* to Log Out and Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated
* CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the
* custom key store.
*
*
* @see ConnectionErrorCodeType
*/
public String getConnectionErrorCode() {
return this.connectionErrorCode;
}
/**
*
* Describes the connection error. This field appears in the response only when the ConnectionState is
* FAILED. For help resolving these errors, see How to Fix a
* Connection Failure in Key Management Service Developer Guide.
*
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
* connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
* ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
* user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
* change the kmsuser account password and update the key store password value for the custom key
* store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
* all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
* fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
* process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
* Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
* cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password value for
* the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
* cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
* Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
* out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
* update the key store password value for the custom key store. For help, see How to Log Out and
* Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the custom key
* store.
*
*
*
*
* @param connectionErrorCode
* Describes the connection error. This field appears in the response only when the
* ConnectionState is FAILED. For help resolving these errors, see How to
* Fix a Connection Failure in Key Management Service Developer Guide.
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active
* HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active
* HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the
* request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to
* connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser
* crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster,
* you must change the kmsuser account password and update the key store password value for the
* custom key store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot
* find all of the subnets in the cluster configuration, attempts to connect the custom key store to the
* CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your
* custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For
* details, see How to
* Fix a Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated
* CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to
* its CloudHSM cluster, you must change the kmsuser account password and update the key store
* password value for the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated
* CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging
* into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the
* kmsuser CU out of the cluster. If you changed the kmsuser password to log into
* the cluster, you must also and update the key store password value for the custom key store. For help, see
* How to
* Log Out and Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the
* custom key store.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionErrorCodeType
*/
public CustomKeyStoresListEntry withConnectionErrorCode(String connectionErrorCode) {
setConnectionErrorCode(connectionErrorCode);
return this;
}
/**
*
* Describes the connection error. This field appears in the response only when the ConnectionState is
* FAILED. For help resolving these errors, see How to Fix a
* Connection Failure in Key Management Service Developer Guide.
*
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
* connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
* ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
* user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
* change the kmsuser account password and update the key store password value for the custom key
* store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
* all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
* fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
* process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
* Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
* cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
* cluster, you must change the kmsuser account password and update the key store password value for
* the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
* cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
* Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
* out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
* update the key store password value for the custom key store. For help, see How to Log Out and
* Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the custom key
* store.
*
*
*
*
* @param connectionErrorCode
* Describes the connection error. This field appears in the response only when the
* ConnectionState is FAILED. For help resolving these errors, see How to
* Fix a Connection Failure in Key Management Service Developer Guide.
*
* Valid values are:
*
*
* -
*
* CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
*
*
* -
*
* INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active
* HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active
* HSM.
*
*
* -
*
* INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the
* request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to
* connect again.
*
*
* -
*
* INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser
* crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster,
* you must change the kmsuser account password and update the key store password value for the
* custom key store.
*
*
* -
*
* NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
*
*
* -
*
* SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot
* find all of the subnets in the cluster configuration, attempts to connect the custom key store to the
* CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your
* custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For
* details, see How to
* Fix a Connection Failure in the Key Management Service Developer Guide.
*
*
* -
*
* USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated
* CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to
* its CloudHSM cluster, you must change the kmsuser account password and update the key store
* password value for the custom key store.
*
*
* -
*
* USER_LOGGED_IN - The kmsuser CU account is logged into the the associated
* CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging
* into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the
* kmsuser CU out of the cluster. If you changed the kmsuser password to log into
* the cluster, you must also and update the key store password value for the custom key store. For help, see
* How to
* Log Out and Reconnect in the Key Management Service Developer Guide.
*
*
* -
*
* USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
* cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
* kmsuser CU account in the cluster, and then update the key store password value for the
* custom key store.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionErrorCodeType
*/
public CustomKeyStoresListEntry withConnectionErrorCode(ConnectionErrorCodeType connectionErrorCode) {
this.connectionErrorCode = connectionErrorCode.toString();
return this;
}
/**
*
* The date and time when the custom key store was created.
*
*
* @param creationDate
* The date and time when the custom key store was created.
*/
public void setCreationDate(java.util.Date creationDate) {
this.creationDate = creationDate;
}
/**
*
* The date and time when the custom key store was created.
*
*
* @return The date and time when the custom key store was created.
*/
public java.util.Date getCreationDate() {
return this.creationDate;
}
/**
*
* The date and time when the custom key store was created.
*
*
* @param creationDate
* The date and time when the custom key store was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomKeyStoresListEntry withCreationDate(java.util.Date creationDate) {
setCreationDate(creationDate);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCustomKeyStoreId() != null)
sb.append("CustomKeyStoreId: ").append(getCustomKeyStoreId()).append(",");
if (getCustomKeyStoreName() != null)
sb.append("CustomKeyStoreName: ").append(getCustomKeyStoreName()).append(",");
if (getCloudHsmClusterId() != null)
sb.append("CloudHsmClusterId: ").append(getCloudHsmClusterId()).append(",");
if (getTrustAnchorCertificate() != null)
sb.append("TrustAnchorCertificate: ").append(getTrustAnchorCertificate()).append(",");
if (getConnectionState() != null)
sb.append("ConnectionState: ").append(getConnectionState()).append(",");
if (getConnectionErrorCode() != null)
sb.append("ConnectionErrorCode: ").append(getConnectionErrorCode()).append(",");
if (getCreationDate() != null)
sb.append("CreationDate: ").append(getCreationDate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CustomKeyStoresListEntry == false)
return false;
CustomKeyStoresListEntry other = (CustomKeyStoresListEntry) obj;
if (other.getCustomKeyStoreId() == null ^ this.getCustomKeyStoreId() == null)
return false;
if (other.getCustomKeyStoreId() != null && other.getCustomKeyStoreId().equals(this.getCustomKeyStoreId()) == false)
return false;
if (other.getCustomKeyStoreName() == null ^ this.getCustomKeyStoreName() == null)
return false;
if (other.getCustomKeyStoreName() != null && other.getCustomKeyStoreName().equals(this.getCustomKeyStoreName()) == false)
return false;
if (other.getCloudHsmClusterId() == null ^ this.getCloudHsmClusterId() == null)
return false;
if (other.getCloudHsmClusterId() != null && other.getCloudHsmClusterId().equals(this.getCloudHsmClusterId()) == false)
return false;
if (other.getTrustAnchorCertificate() == null ^ this.getTrustAnchorCertificate() == null)
return false;
if (other.getTrustAnchorCertificate() != null && other.getTrustAnchorCertificate().equals(this.getTrustAnchorCertificate()) == false)
return false;
if (other.getConnectionState() == null ^ this.getConnectionState() == null)
return false;
if (other.getConnectionState() != null && other.getConnectionState().equals(this.getConnectionState()) == false)
return false;
if (other.getConnectionErrorCode() == null ^ this.getConnectionErrorCode() == null)
return false;
if (other.getConnectionErrorCode() != null && other.getConnectionErrorCode().equals(this.getConnectionErrorCode()) == false)
return false;
if (other.getCreationDate() == null ^ this.getCreationDate() == null)
return false;
if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCustomKeyStoreId() == null) ? 0 : getCustomKeyStoreId().hashCode());
hashCode = prime * hashCode + ((getCustomKeyStoreName() == null) ? 0 : getCustomKeyStoreName().hashCode());
hashCode = prime * hashCode + ((getCloudHsmClusterId() == null) ? 0 : getCloudHsmClusterId().hashCode());
hashCode = prime * hashCode + ((getTrustAnchorCertificate() == null) ? 0 : getTrustAnchorCertificate().hashCode());
hashCode = prime * hashCode + ((getConnectionState() == null) ? 0 : getConnectionState().hashCode());
hashCode = prime * hashCode + ((getConnectionErrorCode() == null) ? 0 : getConnectionErrorCode().hashCode());
hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode());
return hashCode;
}
@Override
public CustomKeyStoresListEntry clone() {
try {
return (CustomKeyStoresListEntry) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kms.model.transform.CustomKeyStoresListEntryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}