MaterialProviders (aws-cryptographic-material-providers 1.0.2 API)

java.lang.Object
- software.amazon.cryptography.materialproviders.MaterialProviders

public class MaterialProviders
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MaterialProviders.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MaterialProviders.Builder`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MaterialProviders(software.amazon.cryptography.materialproviders.MaterialProviders.BuilderImpl builder)

Constructors
Modifier	Constructor and Description
`protected`	`MaterialProviders(software.amazon.cryptography.materialproviders.MaterialProviders.BuilderImpl builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MaterialProviders.Builder`	`builder()`
`IKeyring`	`CreateAwsKmsDiscoveryKeyring(CreateAwsKmsDiscoveryKeyringInput input)` Creates an AWS KMS Discovery Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key for a single region.
`IKeyring`	`CreateAwsKmsDiscoveryMultiKeyring(CreateAwsKmsDiscoveryMultiKeyringInput input)` Creates an AWS KMS Discovery Multi-Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key, for multiple regions.
`IKeyring`	`CreateAwsKmsHierarchicalKeyring(CreateAwsKmsHierarchicalKeyringInput input)` Creates a Hierarchical Keyring, which supports wrapping and unwrapping data keys using Branch Keys persisted in DynamoDB and protected by a symmetric AWS KMS Key or AWS KMS Multi-Region Key.
`IKeyring`	`CreateAwsKmsKeyring(CreateAwsKmsKeyringInput input)` Creates an AWS KMS Keyring, which wraps and unwraps data keys using single symmetric AWS KMS Key.
`IKeyring`	`CreateAwsKmsMrkDiscoveryKeyring(CreateAwsKmsMrkDiscoveryKeyringInput input)` Creates an AWS KMS MRK Discovery Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key or AWS KMS Multi-Region Key in a particular region.
`IKeyring`	`CreateAwsKmsMrkDiscoveryMultiKeyring(CreateAwsKmsMrkDiscoveryMultiKeyringInput input)` Creates an AWS KMS MRK Discovery Multi-Keyring that supports unwrapping data keys wrapped by a symmetric AWS KMS Key or AWS KMS Multi-Region Key, for a single region.
`IKeyring`	`CreateAwsKmsMrkKeyring(CreateAwsKmsMrkKeyringInput input)` Creates an AWS KMS MRK Keyring, which wraps and unwraps data keys using single symmetric AWS KMS Key or AWS KMS Multi-Region Key.
`IKeyring`	`CreateAwsKmsMrkMultiKeyring(CreateAwsKmsMrkMultiKeyringInput input)` Creates an AWS KMS MRK Multi-Keyring, which wraps and unwraps data keys using one or more symmetric AWS KMS Keys or AWS KMS Multi-Region Keys.
`IKeyring`	`CreateAwsKmsMultiKeyring(CreateAwsKmsMultiKeyringInput input)` Creates an AWS KMS Multi-Keyring, which wraps and unwraps data keys using one or more symmetric AWS KMS Keys.
`IKeyring`	`CreateAwsKmsRsaKeyring(CreateAwsKmsRsaKeyringInput input)` Creates an AWS KMS RSA Keyring, which wraps and unwraps data keys using a single asymmetric AWS KMS Key for RSA.
`ICryptographicMaterialsCache`	`CreateCryptographicMaterialsCache(CreateCryptographicMaterialsCacheInput input)`
`IClientSupplier`	`CreateDefaultClientSupplier(CreateDefaultClientSupplierInput input)`
`ICryptographicMaterialsManager`	`CreateDefaultCryptographicMaterialsManager(CreateDefaultCryptographicMaterialsManagerInput input)` Creates a Default Cryptographic Materials Manager.
`IKeyring`	`CreateMultiKeyring(CreateMultiKeyringInput input)` Creates a Multi-Keyring comprised of one or more other Keyrings.
`IKeyring`	`CreateRawAesKeyring(CreateRawAesKeyringInput input)` Creates a Raw AES Keyring, which wraps and unwraps data keys locally using AES_GCM.
`IKeyring`	`CreateRawRsaKeyring(CreateRawRsaKeyringInput input)` Creates a Raw RSA Keyring, which wraps and unwraps data keys locally using RSA.
`ICryptographicMaterialsManager`	`CreateRequiredEncryptionContextCMM(CreateRequiredEncryptionContextCMMInput input)` Creates an Required Encryption Context Cryptographic Materials Manager.
`void`	`DecryptionMaterialsWithPlaintextDataKey(DecryptionMaterials input)`
`void`	`EncryptionMaterialsHasPlaintextDataKey(EncryptionMaterials input)`
`AlgorithmSuiteInfo`	`GetAlgorithmSuiteInfo(java.nio.ByteBuffer input)`
`protected IAwsCryptographicMaterialProvidersClient`	`impl()`
`DecryptionMaterials`	`InitializeDecryptionMaterials(InitializeDecryptionMaterialsInput input)`
`EncryptionMaterials`	`InitializeEncryptionMaterials(InitializeEncryptionMaterialsInput input)`
`void`	`ValidAlgorithmSuiteInfo(AlgorithmSuiteInfo input)`
`void`	`ValidateCommitmentPolicyOnDecrypt(ValidateCommitmentPolicyOnDecryptInput input)`
`void`	`ValidateCommitmentPolicyOnEncrypt(ValidateCommitmentPolicyOnEncryptInput input)`
`void`	`ValidDecryptionMaterialsTransition(ValidDecryptionMaterialsTransitionInput input)`
`void`	`ValidEncryptionMaterialsTransition(ValidEncryptionMaterialsTransitionInput input)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaterialProviders
```
protected MaterialProviders(software.amazon.cryptography.materialproviders.MaterialProviders.BuilderImpl builder)
```
- Method Detail
  - builder
```
public static MaterialProviders.Builder builder()
```
  - CreateAwsKmsDiscoveryKeyring
```
public IKeyring CreateAwsKmsDiscoveryKeyring(CreateAwsKmsDiscoveryKeyringInput input)
```
    Creates an AWS KMS Discovery Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key for a single region.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS Discovery Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsDiscoveryMultiKeyring
```
public IKeyring CreateAwsKmsDiscoveryMultiKeyring(CreateAwsKmsDiscoveryMultiKeyringInput input)
```
    Creates an AWS KMS Discovery Multi-Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key, for multiple regions.
    
    Parameters:
    
    input - Inputs for for creating an AWS KMS Discovery Multi-Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsHierarchicalKeyring
```
public IKeyring CreateAwsKmsHierarchicalKeyring(CreateAwsKmsHierarchicalKeyringInput input)
```
    Creates a Hierarchical Keyring, which supports wrapping and unwrapping data keys using Branch Keys persisted in DynamoDB and protected by a symmetric AWS KMS Key or AWS KMS Multi-Region Key.
    
    Parameters:
    
    input - Inputs for creating a Hierarchical Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsKeyring
```
public IKeyring CreateAwsKmsKeyring(CreateAwsKmsKeyringInput input)
```
    Creates an AWS KMS Keyring, which wraps and unwraps data keys using single symmetric AWS KMS Key.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsMrkDiscoveryKeyring
```
public IKeyring CreateAwsKmsMrkDiscoveryKeyring(CreateAwsKmsMrkDiscoveryKeyringInput input)
```
    Creates an AWS KMS MRK Discovery Keyring, which supports unwrapping data keys wrapped by a symmetric AWS KMS Key or AWS KMS Multi-Region Key in a particular region.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS MRK Discovery Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsMrkDiscoveryMultiKeyring
```
public IKeyring CreateAwsKmsMrkDiscoveryMultiKeyring(CreateAwsKmsMrkDiscoveryMultiKeyringInput input)
```
    Creates an AWS KMS MRK Discovery Multi-Keyring that supports unwrapping data keys wrapped by a symmetric AWS KMS Key or AWS KMS Multi-Region Key, for a single region.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS MRK Discovery Multi-Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsMrkKeyring
```
public IKeyring CreateAwsKmsMrkKeyring(CreateAwsKmsMrkKeyringInput input)
```
    Creates an AWS KMS MRK Keyring, which wraps and unwraps data keys using single symmetric AWS KMS Key or AWS KMS Multi-Region Key.
    
    Parameters:
    
    input - Inputs for for creating an AWS KMS MRK Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsMrkMultiKeyring
```
public IKeyring CreateAwsKmsMrkMultiKeyring(CreateAwsKmsMrkMultiKeyringInput input)
```
    Creates an AWS KMS MRK Multi-Keyring, which wraps and unwraps data keys using one or more symmetric AWS KMS Keys or AWS KMS Multi-Region Keys.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS MRK Multi-Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsMultiKeyring
```
public IKeyring CreateAwsKmsMultiKeyring(CreateAwsKmsMultiKeyringInput input)
```
    Creates an AWS KMS Multi-Keyring, which wraps and unwraps data keys using one or more symmetric AWS KMS Keys.
    
    Parameters:
    
    input - Inputs for for creating a AWS KMS Multi-Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateAwsKmsRsaKeyring
```
public IKeyring CreateAwsKmsRsaKeyring(CreateAwsKmsRsaKeyringInput input)
```
    Creates an AWS KMS RSA Keyring, which wraps and unwraps data keys using a single asymmetric AWS KMS Key for RSA.
    
    Parameters:
    
    input - Inputs for creating a AWS KMS RSA Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateCryptographicMaterialsCache
```
public ICryptographicMaterialsCache CreateCryptographicMaterialsCache(CreateCryptographicMaterialsCacheInput input)
```
  - CreateDefaultClientSupplier
```
public IClientSupplier CreateDefaultClientSupplier(CreateDefaultClientSupplierInput input)
```
  - CreateDefaultCryptographicMaterialsManager
```
public ICryptographicMaterialsManager CreateDefaultCryptographicMaterialsManager(CreateDefaultCryptographicMaterialsManagerInput input)
```
    Creates a Default Cryptographic Materials Manager.
    
    Parameters:
    
    input - Inputs for creating a Default Cryptographic Materials Manager.
    
    Returns:
    
    Outputs for creating a Default Cryptographic Materials Manager.
  - CreateMultiKeyring
```
public IKeyring CreateMultiKeyring(CreateMultiKeyringInput input)
```
    Creates a Multi-Keyring comprised of one or more other Keyrings.
    
    Parameters:
    
    input - Inputs for creating a Multi-Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateRawAesKeyring
```
public IKeyring CreateRawAesKeyring(CreateRawAesKeyringInput input)
```
    Creates a Raw AES Keyring, which wraps and unwraps data keys locally using AES_GCM.
    
    Parameters:
    
    input - Inputs for creating a Raw AES Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateRawRsaKeyring
```
public IKeyring CreateRawRsaKeyring(CreateRawRsaKeyringInput input)
```
    Creates a Raw RSA Keyring, which wraps and unwraps data keys locally using RSA.
    
    Parameters:
    
    input - Inputs for creating a Raw RAW Keyring.
    
    Returns:
    
    Outputs for creating a Keyring.
  - CreateRequiredEncryptionContextCMM
```
public ICryptographicMaterialsManager CreateRequiredEncryptionContextCMM(CreateRequiredEncryptionContextCMMInput input)
```
    Creates an Required Encryption Context Cryptographic Materials Manager.
    
    Parameters:
    
    input - Inputs for creating an Required Encryption Context Cryptographic Materials Manager.
    
    Returns:
    
    Outputs for creating an Required Encryption Context Cryptographic Materials Manager.
  - DecryptionMaterialsWithPlaintextDataKey
```
public void DecryptionMaterialsWithPlaintextDataKey(DecryptionMaterials input)
```
  - EncryptionMaterialsHasPlaintextDataKey
```
public void EncryptionMaterialsHasPlaintextDataKey(EncryptionMaterials input)
```
  - GetAlgorithmSuiteInfo
```
public AlgorithmSuiteInfo GetAlgorithmSuiteInfo(java.nio.ByteBuffer input)
```
  - InitializeDecryptionMaterials
```
public DecryptionMaterials InitializeDecryptionMaterials(InitializeDecryptionMaterialsInput input)
```
  - InitializeEncryptionMaterials
```
public EncryptionMaterials InitializeEncryptionMaterials(InitializeEncryptionMaterialsInput input)
```
  - ValidAlgorithmSuiteInfo
```
public void ValidAlgorithmSuiteInfo(AlgorithmSuiteInfo input)
```
  - ValidateCommitmentPolicyOnDecrypt
```
public void ValidateCommitmentPolicyOnDecrypt(ValidateCommitmentPolicyOnDecryptInput input)
```
  - ValidateCommitmentPolicyOnEncrypt
```
public void ValidateCommitmentPolicyOnEncrypt(ValidateCommitmentPolicyOnEncryptInput input)
```
  - ValidDecryptionMaterialsTransition
```
public void ValidDecryptionMaterialsTransition(ValidDecryptionMaterialsTransitionInput input)
```
  - ValidEncryptionMaterialsTransition
```
public void ValidEncryptionMaterialsTransition(ValidEncryptionMaterialsTransitionInput input)
```
  - impl
```
protected IAwsCryptographicMaterialProvidersClient impl()
```

Class MaterialProviders

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MaterialProviders

Method Detail

builder

CreateAwsKmsDiscoveryKeyring

CreateAwsKmsDiscoveryMultiKeyring

CreateAwsKmsHierarchicalKeyring

CreateAwsKmsKeyring

CreateAwsKmsMrkDiscoveryKeyring

CreateAwsKmsMrkDiscoveryMultiKeyring

CreateAwsKmsMrkKeyring

CreateAwsKmsMrkMultiKeyring

CreateAwsKmsMultiKeyring

CreateAwsKmsRsaKeyring

CreateCryptographicMaterialsCache

CreateDefaultClientSupplier

CreateDefaultCryptographicMaterialsManager

CreateMultiKeyring

CreateRawAesKeyring

CreateRawRsaKeyring

CreateRequiredEncryptionContextCMM

DecryptionMaterialsWithPlaintextDataKey

EncryptionMaterialsHasPlaintextDataKey

GetAlgorithmSuiteInfo

InitializeDecryptionMaterials

InitializeEncryptionMaterials

ValidAlgorithmSuiteInfo

ValidateCommitmentPolicyOnDecrypt

ValidateCommitmentPolicyOnEncrypt

ValidDecryptionMaterialsTransition

ValidEncryptionMaterialsTransition

impl