software.amazon.awssdk.services.accessanalyzer.model

Class KmsGrantConfiguration

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.KmsGrantConfiguration

All Implemented Interfaces:

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

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

A proposed grant configuration for a KMS key. For more information, see CreateGrant.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KmsGrantConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static KmsGrantConfiguration.Builder	builder()
KmsGrantConstraints	constraints() Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	granteePrincipal() The principal that is given permission to perform the operations that the grant permits.
int	hashCode()
boolean	hasOperations() For responses, this returns true if the service returned a value for the Operations property.
String	issuingAccount() The Amazon Web Services account under which the grant was issued.
List<KmsGrantOperation>	operations() A list of operations that the grant permits.
List<String>	operationsAsStrings() A list of operations that the grant permits.
String	retiringPrincipal() The principal that is given permission to retire the grant by using RetireGrant operation.
List<SdkField<?>>	sdkFields()
static Class<? extends KmsGrantConfiguration.Builder>	serializableBuilderClass()
KmsGrantConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

constraints

public final KmsGrantConstraints constraints()

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.

Returns:

Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.

granteePrincipal

public final String granteePrincipal()

The principal that is given permission to perform the operations that the grant permits.

Returns:

The principal that is given permission to perform the operations that the grant permits.

issuingAccount

public final String issuingAccount()

The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.

Returns:

The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.

operations

public final List<KmsGrantOperation> operations()

A list of operations that the grant permits.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperations() method.

Returns:

A list of operations that the grant permits.

hasOperations

public final boolean hasOperations()

For responses, this returns true if the service returned a value for the Operations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

operationsAsStrings

public final List<String> operationsAsStrings()

A list of operations that the grant permits.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperations() method.

Returns:

A list of operations that the grant permits.

retiringPrincipal

public final String retiringPrincipal()

The principal that is given permission to retire the grant by using RetireGrant operation.

Returns:

The principal that is given permission to retire the grant by using RetireGrant operation.

toBuilder

public KmsGrantConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KmsGrantConfiguration.Builder,KmsGrantConfiguration>

builder

public static KmsGrantConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo