com.amazonaws.services.kms.model.GetParametersForImportRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetParametersForImportRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the KMS key that will be associated with the imported key material. The Origin of
* the KMS key must be EXTERNAL.
*
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS
* key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*/
private String keyId;
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*/
private String wrappingAlgorithm;
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*/
private String wrappingKeySpec;
/**
*
* The identifier of the KMS key that will be associated with the imported key material. The Origin of
* the KMS key must be EXTERNAL.
*
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS
* key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @param keyId
* The identifier of the KMS key that will be associated with the imported key material. The
* Origin of the KMS key must be EXTERNAL.
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into
* a KMS key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* The identifier of the KMS key that will be associated with the imported key material. The Origin of
* the KMS key must be EXTERNAL.
*
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS
* key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @return The identifier of the KMS key that will be associated with the imported key material. The
* Origin of the KMS key must be EXTERNAL.
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material
* into a KMS key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* The identifier of the KMS key that will be associated with the imported key material. The Origin of
* the KMS key must be EXTERNAL.
*
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS
* key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @param keyId
* The identifier of the KMS key that will be associated with the imported key material. The
* Origin of the KMS key must be EXTERNAL.
*
* All KMS key types are supported, including multi-Region keys. However, you cannot import key material into
* a KMS key in a custom key store.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetParametersForImportRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*
* @param wrappingAlgorithm
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect
* your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then
* encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key
* material directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To
* import an RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private
* key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5
* wrapping algorithm.
*
*
* @see AlgorithmSpec
*/
public void setWrappingAlgorithm(String wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm;
}
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*
* @return The algorithm you will use with the RSA public key (PublicKey) in the response to protect
* your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then
* encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your
* key material directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To
* import an RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private
* key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5
* wrapping algorithm.
*
*
* @see AlgorithmSpec
*/
public String getWrappingAlgorithm() {
return this.wrappingAlgorithm;
}
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*
* @param wrappingAlgorithm
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect
* your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then
* encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key
* material directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To
* import an RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private
* key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5
* wrapping algorithm.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
public GetParametersForImportRequest withWrappingAlgorithm(String wrappingAlgorithm) {
setWrappingAlgorithm(wrappingAlgorithm);
return this;
}
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*
* @param wrappingAlgorithm
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect
* your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then
* encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key
* material directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To
* import an RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private
* key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5
* wrapping algorithm.
*
*
* @see AlgorithmSpec
*/
public void setWrappingAlgorithm(AlgorithmSpec wrappingAlgorithm) {
withWrappingAlgorithm(wrappingAlgorithm);
}
/**
*
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key
* material during import. For more information, see Select a
* wrapping algorithm in the Key Management Service Developer Guide.
*
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt
* your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material
* directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an
* RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521
* key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping
* algorithm.
*
*
*
*
* @param wrappingAlgorithm
* The algorithm you will use with the RSA public key (PublicKey) in the response to protect
* your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.
*
* For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then
* encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key
* material directly with the RSA public key from KMS.
*
*
* The wrapping algorithms that you can use depend on the type of key material that you are importing. To
* import an RSA private key, you must use an RSA_AES wrapping algorithm.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
*
*
* -
*
* RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private
* key).
*
*
* You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).
*
*
* You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap
* ECC_NIST_P521 key material.
*
*
* -
*
* RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5
* wrapping algorithm.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlgorithmSpec
*/
public GetParametersForImportRequest withWrappingAlgorithm(AlgorithmSpec wrappingAlgorithm) {
this.wrappingAlgorithm = wrappingAlgorithm.toString();
return this;
}
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*
* @param wrappingKeySpec
* The type of RSA public key to return in the response. You will use this wrapping key with the specified
* wrapping algorithm to protect your key material during import.
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an
* RSA_AES wrapping algorithm or choose a longer RSA public key.
* @see WrappingKeySpec
*/
public void setWrappingKeySpec(String wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec;
}
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*
* @return The type of RSA public key to return in the response. You will use this wrapping key with the specified
* wrapping algorithm to protect your key material during import.
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an
* RSA_AES wrapping algorithm or choose a longer RSA public key.
* @see WrappingKeySpec
*/
public String getWrappingKeySpec() {
return this.wrappingKeySpec;
}
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*
* @param wrappingKeySpec
* The type of RSA public key to return in the response. You will use this wrapping key with the specified
* wrapping algorithm to protect your key material during import.
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an
* RSA_AES wrapping algorithm or choose a longer RSA public key.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
public GetParametersForImportRequest withWrappingKeySpec(String wrappingKeySpec) {
setWrappingKeySpec(wrappingKeySpec);
return this;
}
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*
* @param wrappingKeySpec
* The type of RSA public key to return in the response. You will use this wrapping key with the specified
* wrapping algorithm to protect your key material during import.
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an
* RSA_AES wrapping algorithm or choose a longer RSA public key.
* @see WrappingKeySpec
*/
public void setWrappingKeySpec(WrappingKeySpec wrappingKeySpec) {
withWrappingKeySpec(wrappingKeySpec);
}
/**
*
* The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping
* algorithm to protect your key material during import.
*
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES
* wrapping algorithm or choose a longer RSA public key.
*
*
* @param wrappingKeySpec
* The type of RSA public key to return in the response. You will use this wrapping key with the specified
* wrapping algorithm to protect your key material during import.
*
* Use the longest RSA wrapping key that is practical.
*
*
* You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an
* RSA_AES wrapping algorithm or choose a longer RSA public key.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WrappingKeySpec
*/
public GetParametersForImportRequest withWrappingKeySpec(WrappingKeySpec wrappingKeySpec) {
this.wrappingKeySpec = wrappingKeySpec.toString();
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 (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getWrappingAlgorithm() != null)
sb.append("WrappingAlgorithm: ").append(getWrappingAlgorithm()).append(",");
if (getWrappingKeySpec() != null)
sb.append("WrappingKeySpec: ").append(getWrappingKeySpec());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetParametersForImportRequest == false)
return false;
GetParametersForImportRequest other = (GetParametersForImportRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getWrappingAlgorithm() == null ^ this.getWrappingAlgorithm() == null)
return false;
if (other.getWrappingAlgorithm() != null && other.getWrappingAlgorithm().equals(this.getWrappingAlgorithm()) == false)
return false;
if (other.getWrappingKeySpec() == null ^ this.getWrappingKeySpec() == null)
return false;
if (other.getWrappingKeySpec() != null && other.getWrappingKeySpec().equals(this.getWrappingKeySpec()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getWrappingAlgorithm() == null) ? 0 : getWrappingAlgorithm().hashCode());
hashCode = prime * hashCode + ((getWrappingKeySpec() == null) ? 0 : getWrappingKeySpec().hashCode());
return hashCode;
}
@Override
public GetParametersForImportRequest clone() {
return (GetParametersForImportRequest) super.clone();
}
}