GrantConstraints (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kms.model.GrantConstraints

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GrantConstraints
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.

Grant constraints apply only to operations that accept encryption context as input. For example, the DescribeKey operation does not accept encryption context as input. A grant that allows the DescribeKey operation does so regardless of the grant constraints. In constrast, the Encrypt operation accepts encryption context as input. A grant that allows the Encrypt operation does so only when the encryption context of the Encrypt operation satisfies the grant constraints.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GrantConstraints()

Constructors
Constructor and Description
`GrantConstraints()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GrantConstraints`	`addEncryptionContextEqualsEntry(String key, String value)`
`GrantConstraints`	`addEncryptionContextSubsetEntry(String key, String value)`
`GrantConstraints`	`clearEncryptionContextEqualsEntries()` Removes all the entries added into EncryptionContextEquals.
`GrantConstraints`	`clearEncryptionContextSubsetEntries()` Removes all the entries added into EncryptionContextSubset.
`GrantConstraints`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getEncryptionContextEquals()` A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
`Map<String,String>`	`getEncryptionContextSubset()` A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEncryptionContextEquals(Map<String,String> encryptionContextEquals)` A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
`void`	`setEncryptionContextSubset(Map<String,String> encryptionContextSubset)` A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GrantConstraints`	`withEncryptionContextEquals(Map<String,String> encryptionContextEquals)` A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
`GrantConstraints`	`withEncryptionContextSubset(Map<String,String> encryptionContextSubset)` A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GrantConstraints
```
public GrantConstraints()
```
- Method Detail
  - getEncryptionContextSubset
```
public Map<String,String> getEncryptionContextSubset()
```
    A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Returns:
    
    A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
  - setEncryptionContextSubset
```
public void setEncryptionContextSubset(Map<String,String> encryptionContextSubset)
```
    A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Parameters:
    
    encryptionContextSubset - A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
  - withEncryptionContextSubset
```
public GrantConstraints withEncryptionContextSubset(Map<String,String> encryptionContextSubset)
```
    A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Parameters:
    
    encryptionContextSubset - A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEncryptionContextSubsetEntry
```
public GrantConstraints addEncryptionContextSubsetEntry(String key,
                                                        String value)
```
  - clearEncryptionContextSubsetEntries
```
public GrantConstraints clearEncryptionContextSubsetEntries()
```
    Removes all the entries added into EncryptionContextSubset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEncryptionContextEquals
```
public Map<String,String> getEncryptionContextEquals()
```
    A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Returns:
    
    A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
  - setEncryptionContextEquals
```
public void setEncryptionContextEquals(Map<String,String> encryptionContextEquals)
```
    A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Parameters:
    
    encryptionContextEquals - A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
  - withEncryptionContextEquals
```
public GrantConstraints withEncryptionContextEquals(Map<String,String> encryptionContextEquals)
```
    A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Parameters:
    
    encryptionContextEquals - A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEncryptionContextEqualsEntry
```
public GrantConstraints addEncryptionContextEqualsEntry(String key,
                                                        String value)
```
  - clearEncryptionContextEqualsEntries
```
public GrantConstraints clearEncryptionContextEqualsEntries()
```
    Removes all the entries added into EncryptionContextEquals.
    
    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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GrantConstraints clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GrantConstraints

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrantConstraints

Method Detail

getEncryptionContextSubset

setEncryptionContextSubset

withEncryptionContextSubset

addEncryptionContextSubsetEntry

clearEncryptionContextSubsetEntries

getEncryptionContextEquals

setEncryptionContextEquals

withEncryptionContextEquals

addEncryptionContextEqualsEntry

clearEncryptionContextEqualsEntries

toString

equals

hashCode

clone

marshall