Package software.amazon.awssdk.services.accessanalyzer.model

Class KmsKeyConfiguration

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.KmsKeyConfiguration

All Implemented Interfaces:

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

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

Proposed access control configuration for a KMS key. You can propose a configuration for a new KMS key or an existing KMS key that you own by specifying the key policy and KMS grant configuration. If the configuration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see Default key policy. For more information about key policy limits, see Resource quotas.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KmsKeyConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KmsKeyConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<KmsGrantConfiguration>	grants()	A list of proposed grant configurations for the KMS key.
boolean	hasGrants()	For responses, this returns true if the service returned a value for the Grants property.
int	hashCode()
boolean	hasKeyPolicies()	For responses, this returns true if the service returned a value for the KeyPolicies property.
Map<String,String>	keyPolicies()	Resource policy configuration for the KMS key.
List<SdkField<?>>	sdkFields()
static Class<? extends KmsKeyConfiguration.Builder>	serializableBuilderClass()
KmsKeyConfiguration.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

hasKeyPolicies

public final boolean hasKeyPolicies()

For responses, this returns true if the service returned a value for the KeyPolicies 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.

keyPolicies

public final Map<String,String> keyPolicies()

Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.

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 hasKeyPolicies() method.

Returns:

Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.

hasGrants

public final boolean hasGrants()

For responses, this returns true if the service returned a value for the Grants 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.

grants

public final List<KmsGrantConfiguration> grants()

A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.

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 hasGrants() method.

Returns:

A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.

toBuilder

public KmsKeyConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KmsKeyConfiguration.Builder,KmsKeyConfiguration>

builder

public static KmsKeyConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends KmsKeyConfiguration.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