Package 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("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:

  • Method Details

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

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

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

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

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

    • toBuilder

      public KmsGrantConfiguration.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<KmsGrantConfiguration.Builder,KmsGrantConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.