/* * Copyright 2010-2023 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 com.amazonaws.AmazonWebServiceRequest; /** *

* Gets information about custom key stores in the account and Region. *

*

* 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. *

*

* By default, this operation returns information about all custom key stores in * the account and Region. To get only information about a particular custom key * store, use either the CustomKeyStoreName or * CustomKeyStoreId parameter (but not both). *

*

* To determine whether the custom key store is connected to its CloudHSM * cluster or external key store proxy, use the ConnectionState * element in the response. If an attempt to connect the custom key store * failed, the ConnectionState value is FAILED and the * ConnectionErrorCode element in the response indicates the cause * of the failure. For help interpreting the ConnectionErrorCode, * see CustomKeyStoresListEntry. *

*

* Custom key stores have a DISCONNECTED connection state if the * key store has never been connected or you used the * DisconnectCustomKeyStore operation to disconnect it. Otherwise, the * connection state is CONNECTED. If your custom key store connection state is * CONNECTED but you are having trouble using it, verify that the * backing store is active and available. For an CloudHSM key store, verify that * the associated CloudHSM cluster is active and contains the minimum number of * HSMs required for the operation, if any. For an external key store, verify * that the external key store proxy and its associated external key manager are * reachable and enabled. *

*

* For help repairing your CloudHSM key store, see the Troubleshooting CloudHSM key stores. For help repairing your external * key store, see the Troubleshooting external key stores. Both topics are in the Key * Management Service Developer Guide. *

*

* Cross-account use: No. You cannot perform this operation on a custom * key store in a different Amazon Web Services account. *

*

* Required permissions: kms:DescribeCustomKeyStores (IAM policy) *

*

* Related operations: *

* */ public class DescribeCustomKeyStoresRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Gets only information about the specified custom key store. Enter the key * store ID. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 64
*/ private String customKeyStoreId; /** *

* Gets only information about the specified custom key store. Enter the * friendly name of the custom key store. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 256
*/ private String customKeyStoreName; /** *

* Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number * of items, but it might return fewer. *

*

* Constraints:
* Range: 1 - 1000
*/ private Integer limit; /** *

* Use this parameter in a subsequent request after you receive a response * with truncated results. Set it to the value of NextMarker * from the truncated response you just received. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [ -\u00FF]*
*/ private String marker; /** *

* Gets only information about the specified custom key store. Enter the key * store ID. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 64
* * @return

* Gets only information about the specified custom key store. Enter * the key store ID. *

*

* By default, this operation gets information about all custom key * stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName * parameter, but not both. *

*/ public String getCustomKeyStoreId() { return customKeyStoreId; } /** *

* Gets only information about the specified custom key store. Enter the key * store ID. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 64
* * @param customKeyStoreId

* Gets only information about the specified custom key store. * Enter the key store ID. *

*

* By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*/ public void setCustomKeyStoreId(String customKeyStoreId) { this.customKeyStoreId = customKeyStoreId; } /** *

* Gets only information about the specified custom key store. Enter the key * store ID. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 64
* * @param customKeyStoreId

* Gets only information about the specified custom key store. * Enter the key store ID. *

*

* By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeCustomKeyStoresRequest withCustomKeyStoreId(String customKeyStoreId) { this.customKeyStoreId = customKeyStoreId; return this; } /** *

* Gets only information about the specified custom key store. Enter the * friendly name of the custom key store. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 256
* * @return

* Gets only information about the specified custom key store. Enter * the friendly name of the custom key store. *

*

* By default, this operation gets information about all custom key * stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName * parameter, but not both. *

*/ public String getCustomKeyStoreName() { return customKeyStoreName; } /** *

* Gets only information about the specified custom key store. Enter the * friendly name of the custom key store. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Constraints:
* Length: 1 - 256
* * @param customKeyStoreName

* Gets only information about the specified custom key store. * Enter the friendly name of the custom key store. *

*

* By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*/ public void setCustomKeyStoreName(String customKeyStoreName) { this.customKeyStoreName = customKeyStoreName; } /** *

* Gets only information about the specified custom key store. Enter the * friendly name of the custom key store. *

*

* By default, this operation gets information about all custom key stores * in the account and Region. To limit the output to a particular custom key * store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* * @param customKeyStoreName

* Gets only information about the specified custom key store. * Enter the friendly name of the custom key store. *

*

* By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a * particular custom key store, provide either the * CustomKeyStoreId or * CustomKeyStoreName parameter, but not both. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeCustomKeyStoresRequest withCustomKeyStoreName(String customKeyStoreName) { this.customKeyStoreName = customKeyStoreName; return this; } /** *

* Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number * of items, but it might return fewer. *

*

* Constraints:
* Range: 1 - 1000
* * @return

* Use this parameter to specify the maximum number of items to * return. When this value is present, KMS does not return more than * the specified number of items, but it might return fewer. *

*/ public Integer getLimit() { return limit; } /** *

* Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number * of items, but it might return fewer. *

*

* Constraints:
* Range: 1 - 1000
* * @param limit

* Use this parameter to specify the maximum number of items to * return. When this value is present, KMS does not return more * than the specified number of items, but it might return fewer. *

*/ public void setLimit(Integer limit) { this.limit = limit; } /** *

* Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number * of items, but it might return fewer. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 1000
* * @param limit

* Use this parameter to specify the maximum number of items to * return. When this value is present, KMS does not return more * than the specified number of items, but it might return fewer. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeCustomKeyStoresRequest withLimit(Integer limit) { this.limit = limit; return this; } /** *

* Use this parameter in a subsequent request after you receive a response * with truncated results. Set it to the value of NextMarker * from the truncated response you just received. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [ -\u00FF]*
* * @return

* Use this parameter in a subsequent request after you receive a * response with truncated results. Set it to the value of * NextMarker from the truncated response you just * received. *

*/ public String getMarker() { return marker; } /** *

* Use this parameter in a subsequent request after you receive a response * with truncated results. Set it to the value of NextMarker * from the truncated response you just received. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: [ -\u00FF]*
* * @param marker

* Use this parameter in a subsequent request after you receive a * response with truncated results. Set it to the value of * NextMarker from the truncated response you just * received. *

*/ public void setMarker(String marker) { this.marker = marker; } /** *

* Use this parameter in a subsequent request after you receive a response * with truncated results. Set it to the value of NextMarker * from the truncated response you just received. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 1024
* Pattern: [ -\u00FF]*
* * @param marker

* Use this parameter in a subsequent request after you receive a * response with truncated results. Set it to the value of * NextMarker from the truncated response you just * received. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeCustomKeyStoresRequest withMarker(String marker) { this.marker = marker; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getCustomKeyStoreId() + ","); if (getCustomKeyStoreName() != null) sb.append("CustomKeyStoreName: " + getCustomKeyStoreName() + ","); if (getLimit() != null) sb.append("Limit: " + getLimit() + ","); if (getMarker() != null) sb.append("Marker: " + getMarker()); sb.append("}"); return sb.toString(); } @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 + ((getLimit() == null) ? 0 : getLimit().hashCode()); hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeCustomKeyStoresRequest == false) return false; DescribeCustomKeyStoresRequest other = (DescribeCustomKeyStoresRequest) 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.getLimit() == null ^ this.getLimit() == null) return false; if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false; if (other.getMarker() == null ^ this.getMarker() == null) return false; if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false; return true; } }