Package com.amazonaws.encryptionsdk.kms

Class KmsMasterKeyProvider

  • All Implemented Interfaces:
    KmsMethods
    public class KmsMasterKeyProvider
extends MasterKeyProvider<KmsMasterKey>
implements KmsMethods
    Provides MasterKeys backed by the AWS Key Management Service. This object is regional and if you want to use keys from multiple regions, you'll need multiple copies of this object.

    • Constructor Detail

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider()
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings, default credentials, and configured to talk to the Regions.DEFAULT_REGION.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(String keyId)
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings and credentials configured to speak to the region specified by keyId (if specified). Data will be protected with keyId as appropriate.

        The default region will be set to that of the given key ID, or to the AWS SDK default region if a bare key ID or alias is passed.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentials creds,
                            String keyId)
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings configured to speak to the region specified by keyId (if specified). Data will be protected with keyId as appropriate.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentialsProvider creds,
                            String keyId)
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings configured to speak to the region specified by keyId (if specified). Data will be protected with keyId as appropriate.

        The default region will be set to that of the given key ID, or to the AWS SDK default region if a bare key ID or alias is passed.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentials creds)
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings and configured to talk to the Regions.DEFAULT_REGION.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentialsProvider creds)
        Deprecated.
        The default region set by this constructor is subject to change. Use the builder method to construct instances of this class for better control.
        Returns an instance of this object with default settings and configured to talk to the Regions.DEFAULT_REGION.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentialsProvider creds,
                            com.amazonaws.regions.Region region,
                            com.amazonaws.ClientConfiguration clientConfiguration,
                            String keyId)
        Deprecated.
        This constructor implicitly configures the KMS Master Key Provider to perform discovery behavior on decrypt, which is a behavior that should be constructed explicitly. To create a KMS Master Key Provider that continues to perform discovery on decrypt, use KmsMasterKeyProvider.Builder.buildDiscovery() or KmsMasterKeyProvider.Builder.buildDiscovery(DiscoveryFilter). To create a KMS Master Key Provider that restricts what keys to attempt decryption with to a set of configured keys, use KmsMasterKeyProvider.Builder.buildStrict(List).
        Returns an instance of this object with the supplied configuration and credentials. keyId will be used to protect data.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.auth.AWSCredentialsProvider creds,
                            com.amazonaws.regions.Region region,
                            com.amazonaws.ClientConfiguration clientConfiguration,
                            List<String> keyIds)
        Deprecated.
        This constructor implicitly configures the KMS Master Key Provider to perform discovery behavior on decrypt, which is a behavior that should be constructed explicitly. To create a KMS Master Key Provider that continues to perform discovery on decrypt, use KmsMasterKeyProvider.Builder.buildDiscovery() or KmsMasterKeyProvider.Builder.buildDiscovery(DiscoveryFilter). To create a KMS Master Key Provider that restricts what keys to attempt decryption with to a set of configured keys, use KmsMasterKeyProvider.Builder.buildStrict(List).
        Returns an instance of this object with the supplied configuration and credentials. all keys listed in keyIds will be used to protect data.

      • KmsMasterKeyProvider

        @Deprecated
public KmsMasterKeyProvider​(com.amazonaws.services.kms.AWSKMS kms,
                            com.amazonaws.regions.Region region,
                            List<String> keyIds)
        Deprecated.
        This constructor modifies the passed-in KMS client by setting its region. This functionality may be removed in future releases. Use the builder to construct instances of this class instead.
        Returns an instance of this object with the supplied client and region; the client will be configured to use the provided region. All keys listed in keyIds will be used to protect data.