Interface GetParametersForImportRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>, PaymentCryptographyRequest.Builder, SdkBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetParametersForImportRequest

@Mutable
@NotThreadSafe
public static interface GetParametersForImportRequest.Builder
extends PaymentCryptographyRequest.Builder, SdkPojo, CopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>

Method Summary

Modifier and Type	Method	Description
GetParametersForImportRequest.Builder	keyMaterialType(String keyMaterialType)	The method to use for key material import.
GetParametersForImportRequest.Builder	keyMaterialType(KeyMaterialType keyMaterialType)	The method to use for key material import.
GetParametersForImportRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetParametersForImportRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetParametersForImportRequest.Builder	reuseLastGeneratedToken(Boolean reuseLastGeneratedToken)	Specifies whether to reuse the existing import token and wrapping key certificate.
GetParametersForImportRequest.Builder	wrappingKeyAlgorithm(String wrappingKeyAlgorithm)	The wrapping key algorithm to generate a wrapping key certificate.
GetParametersForImportRequest.Builder	wrappingKeyAlgorithm(KeyAlgorithm wrappingKeyAlgorithm)	The wrapping key algorithm to generate a wrapping key certificate.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.paymentcryptography.model.PaymentCryptographyRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

keyMaterialType

GetParametersForImportRequest.Builder keyMaterialType(String keyMaterialType)

The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).

Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

Parameters:

keyMaterialType - The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).

Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

Returns:

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

See Also:

• KeyMaterialType
• KeyMaterialType

keyMaterialType

GetParametersForImportRequest.Builder keyMaterialType(KeyMaterialType keyMaterialType)

The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).

Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

Parameters:

keyMaterialType - The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).

Import token is not required for TR-31, root public key cerificate or trusted public key certificate.

Returns:

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

See Also:

• KeyMaterialType
• KeyMaterialType

wrappingKeyAlgorithm

GetParametersForImportRequest.Builder wrappingKeyAlgorithm(String wrappingKeyAlgorithm)

The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.

Parameters:

wrappingKeyAlgorithm - The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.

Returns:

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

See Also:

• KeyAlgorithm
• KeyAlgorithm

wrappingKeyAlgorithm

GetParametersForImportRequest.Builder wrappingKeyAlgorithm(KeyAlgorithm wrappingKeyAlgorithm)

The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.

Parameters:

wrappingKeyAlgorithm - The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.

At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.

Returns:

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

See Also:

• KeyAlgorithm
• KeyAlgorithm

reuseLastGeneratedToken

GetParametersForImportRequest.Builder reuseLastGeneratedToken(Boolean reuseLastGeneratedToken)

Specifies whether to reuse the existing import token and wrapping key certificate. If set to true and a valid import token exists for the same key material type and wrapping key algorithm with at least 7 days of remaining validity, the existing token and wrapping key certificate are returned. Otherwise, a new import token and wrapping key certificate are generated. The default value is false, which generates a new import token and wrapping key certificate on every call.

Parameters:

reuseLastGeneratedToken - Specifies whether to reuse the existing import token and wrapping key certificate. If set to true and a valid import token exists for the same key material type and wrapping key algorithm with at least 7 days of remaining validity, the existing token and wrapping key certificate are returned. Otherwise, a new import token and wrapping key certificate are generated. The default value is false, which generates a new import token and wrapping key certificate on every call.

Returns:

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

overrideConfiguration

GetParametersForImportRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetParametersForImportRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.