Package software.amazon.awssdk.services.kms.model

Interface GenerateMacRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>, KmsRequest.Builder, SdkBuilder<GenerateMacRequest.Builder,GenerateMacRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GenerateMacRequest
public static interface GenerateMacRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>

  • Method Details

    • message

      GenerateMacRequest.Builder message(SdkBytes message)

      The message to be hashed. Specify a message of up to 4,096 bytes.

      GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

      Parameters:
      message - The message to be hashed. Specify a message of up to 4,096 bytes.

      GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

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

    • keyId

      GenerateMacRequest.Builder keyId(String keyId)

      The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

      To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

      Parameters:
      keyId - The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

      To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

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

    • macAlgorithm

      GenerateMacRequest.Builder macAlgorithm(String macAlgorithm)

      The MAC algorithm used in the operation.

      The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

      Parameters:
      macAlgorithm - The MAC algorithm used in the operation.

      The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

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

    • macAlgorithm

      GenerateMacRequest.Builder macAlgorithm(MacAlgorithmSpec macAlgorithm)

      The MAC algorithm used in the operation.

      The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

      Parameters:
      macAlgorithm - The MAC algorithm used in the operation.

      The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

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

    • grantTokens

      GenerateMacRequest.Builder grantTokens(Collection<String> grantTokens)

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

      Parameters:
      grantTokens - A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

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

    • grantTokens

      GenerateMacRequest.Builder grantTokens(String... grantTokens)

      A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

      Parameters:
      grantTokens - A list of grant tokens.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

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

    • dryRun

      GenerateMacRequest.Builder dryRun(Boolean dryRun)

      Checks if your request will succeed. DryRun is an optional parameter.

      To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

      Parameters:
      dryRun - Checks if your request will succeed. DryRun is an optional parameter.

      To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

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

    • overrideConfiguration

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

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