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

Interface EncryptRequest.Builder

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

  • Method Details

    • keyId

      EncryptRequest.Builder keyId(String keyId)

      Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

      For example:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

      To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

      Parameters:
      keyId - Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

      To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

      For example:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

      To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

    • plaintext

      EncryptRequest.Builder plaintext(SdkBytes plaintext)

      Data to be encrypted.

      Parameters:
      plaintext - Data to be encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionContext

      EncryptRequest.Builder encryptionContext(Map<String,String> encryptionContext)

      Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

      Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

      An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

      For more information, see Encryption context in the Key Management Service Developer Guide.

      Parameters:
      encryptionContext - Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

      Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

      An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

      For more information, see Encryption context in the Key Management Service Developer Guide.

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

    • grantTokens

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

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

    • encryptionAlgorithm

      EncryptRequest.Builder encryptionAlgorithm(String encryptionAlgorithm)

      Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

      This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

      The SM2PKE algorithm is only available in China Regions.

      Parameters:
      encryptionAlgorithm - Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

      This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

      The SM2PKE algorithm is only available in China Regions.

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

    • encryptionAlgorithm

      EncryptRequest.Builder encryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)

      Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

      This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

      The SM2PKE algorithm is only available in China Regions.

      Parameters:
      encryptionAlgorithm - Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

      This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

      The SM2PKE algorithm is only available in China Regions.

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

    • dryRun

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

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

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