@Generated(value="software.amazon.awssdk:codegen") public final class GetParametersForImportRequest extends KmsRequest implements ToCopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetParametersForImportRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetParametersForImportRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
String |
keyId()
The identifier of the symmetric KMS key into which you will import key material.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetParametersForImportRequest.Builder> |
serializableBuilderClass() |
GetParametersForImportRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
AlgorithmSpec |
wrappingAlgorithm()
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
|
String |
wrappingAlgorithmAsString()
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
|
WrappingKeySpec |
wrappingKeySpec()
The type of wrapping key (public key) to return in the response.
|
String |
wrappingKeySpecAsString()
The type of wrapping key (public key) to return in the response.
|
overrideConfigurationcopypublic final String keyId()
The identifier of the symmetric KMS key into which you will import key material. The Origin of the
KMS key must be EXTERNAL.
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.
Origin
of the KMS key must be EXTERNAL.
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 final AlgorithmSpec wrappingAlgorithm()
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm
will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
wrappingAlgorithmAsString().
AlgorithmSpecpublic final String wrappingAlgorithmAsString()
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm
will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
wrappingAlgorithmAsString().
AlgorithmSpecpublic final WrappingKeySpec wrappingKeySpec()
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec
will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from wrappingKeySpecAsString().
WrappingKeySpecpublic final String wrappingKeySpecAsString()
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec
will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from wrappingKeySpecAsString().
WrappingKeySpecpublic GetParametersForImportRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>toBuilder in class KmsRequestpublic static GetParametersForImportRequest.Builder builder()
public static Class<? extends GetParametersForImportRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.