com.amazonaws.services.kms.model

Class GrantConstraints

java.lang.Object

com.amazonaws.services.kms.model.GrantConstraints

All Implemented Interfaces:

Serializable, Cloneable

public class GrantConstraints
extends Object
implements Serializable, Cloneable

A structure for specifying the conditions under which the operations permitted by the grant are allowed.

You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GrantConstraints()

Method Summary

Methods

Modifier and Type	Method and Description
GrantConstraints	addEncryptionContextEqualsEntry(String key, String value) Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant.
GrantConstraints	addEncryptionContextSubsetEntry(String key, String value) Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant.
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() Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant.
Map<String,String>	getEncryptionContextSubset() Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant.
int	hashCode()
void	setEncryptionContextEquals(Map<String,String> encryptionContextEquals) Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant.
void	setEncryptionContextSubset(Map<String,String> encryptionContextSubset) Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GrantConstraints	withEncryptionContextEquals(Map<String,String> encryptionContextEquals) Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant.
GrantConstraints	withEncryptionContextSubset(Map<String,String> encryptionContextSubset) Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GrantConstraints

public GrantConstraints()

Method Detail

getEncryptionContextSubset

public Map<String,String> getEncryptionContextSubset()

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

Returns:

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

setEncryptionContextSubset

public void setEncryptionContextSubset(Map<String,String> encryptionContextSubset)

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

Parameters:

encryptionContextSubset - Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

withEncryptionContextSubset

public GrantConstraints withEncryptionContextSubset(Map<String,String> encryptionContextSubset)

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

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

Parameters:

encryptionContextSubset - Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextSubsetEntry

public GrantConstraints addEncryptionContextSubsetEntry(String key,
                                               String value)

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

The method adds a new key-value pair into EncryptionContextSubset parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EncryptionContextSubset.

value - The corresponding value of the entry to be added into EncryptionContextSubset.

clearEncryptionContextSubsetEntries

public GrantConstraints clearEncryptionContextSubsetEntries()

Removes all the entries added into EncryptionContextSubset.

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

getEncryptionContextEquals

public Map<String,String> getEncryptionContextEquals()

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

Returns:

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

setEncryptionContextEquals

public void setEncryptionContextEquals(Map<String,String> encryptionContextEquals)

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

Parameters:

encryptionContextEquals - Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

withEncryptionContextEquals

public GrantConstraints withEncryptionContextEquals(Map<String,String> encryptionContextEquals)

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

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

Parameters:

encryptionContextEquals - Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

addEncryptionContextEqualsEntry

public GrantConstraints addEncryptionContextEqualsEntry(String key,
                                               String value)

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

The method adds a new key-value pair into EncryptionContextEquals parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into EncryptionContextEquals.

value - The corresponding value of the entry to be added into EncryptionContextEquals.

clearEncryptionContextEqualsEntries

public GrantConstraints clearEncryptionContextEqualsEntries()

Removes all the entries added into EncryptionContextEquals.

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GrantConstraints clone()

Overrides:

clone in class Object