software.amazon.awssdk.services.kms.model

Class GrantConstraints

java.lang.Object

software.amazon.awssdk.services.kms.model.GrantConstraints

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GrantConstraints.Builder,GrantConstraints>

@Generated(value="software.amazon.awssdk:codegen")
public final class GrantConstraints
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GrantConstraints.Builder,GrantConstraints>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrantConstraints.Builder

Method Summary

Modifier and Type	Method and Description
static GrantConstraints.Builder	builder()
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.
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.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GrantConstraints.Builder>	serializableBuilderClass()
GrantConstraints.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

encryptionContextSubset

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

encryptionContextEquals

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

toBuilder

public GrantConstraints.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GrantConstraints.Builder,GrantConstraints>

Returns:

a builder for type T

builder

public static GrantConstraints.Builder builder()

serializableBuilderClass

public static Class<? extends GrantConstraints.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.