Class GenerateDataKeyWithoutPlaintextRequest

    • Constructor Detail

      • GenerateDataKeyWithoutPlaintextRequest

        public GenerateDataKeyWithoutPlaintextRequest()
    • Method Detail

      • setKeyId

        public void setKeyId​(String keyId)

        A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

        Parameters:
        keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

      • getKeyId

        public String getKeyId()

        A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

        Returns:
        A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678- 1234-1234-1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

      • withKeyId

        public GenerateDataKeyWithoutPlaintextRequest withKeyId​(String keyId)

        A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

        Parameters:
        keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

        • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        • Alias Name Example - alias/MyAliasName

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

        public Map<String,​String> getEncryptionContext()

        Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

        Returns:
        Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
      • setEncryptionContext

        public void setEncryptionContext​(Map<String,​String> encryptionContext)

        Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

        Parameters:
        encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
      • withEncryptionContext

        public GenerateDataKeyWithoutPlaintextRequest withEncryptionContext​(Map<String,​String> encryptionContext)

        Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

        Parameters:
        encryptionContext - Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearEncryptionContextEntries

        public GenerateDataKeyWithoutPlaintextRequest clearEncryptionContextEntries()
        Removes all the entries added into EncryptionContext. <p> Returns a reference to this object so that method calls can be chained together.
      • setKeySpec

        public void setKeySpec​(String keySpec)

        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

        Parameters:
        keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
        See Also:
        DataKeySpec
      • getKeySpec

        public String getKeySpec()

        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

        Returns:
        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
        See Also:
        DataKeySpec
      • withKeySpec

        public GenerateDataKeyWithoutPlaintextRequest withKeySpec​(String keySpec)

        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

        Parameters:
        keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataKeySpec
      • setKeySpec

        public void setKeySpec​(DataKeySpec keySpec)

        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

        Parameters:
        keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
        See Also:
        DataKeySpec
      • withKeySpec

        public GenerateDataKeyWithoutPlaintextRequest withKeySpec​(DataKeySpec keySpec)

        Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.

        Parameters:
        keySpec - Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataKeySpec
      • setNumberOfBytes

        public void setNumberOfBytes​(Integer numberOfBytes)

        Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

        Parameters:
        numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.
      • getNumberOfBytes

        public Integer getNumberOfBytes()

        Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

        Returns:
        Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.
      • withNumberOfBytes

        public GenerateDataKeyWithoutPlaintextRequest withNumberOfBytes​(Integer numberOfBytes)

        Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.

        Parameters:
        numberOfBytes - Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getGrantTokens

        public List<String> getGrantTokens()

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Returns:
        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

      • setGrantTokens

        public void setGrantTokens​(Collection<String> grantTokens)

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

      • withGrantTokens

        public GenerateDataKeyWithoutPlaintextRequest withGrantTokens​(Collection<String> grantTokens)

        A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

        Parameters:
        grantTokens - A list of grant tokens.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object