Class KmsAccess

java.lang.Object
software.amazon.awssdk.services.odb.model.KmsAccess
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KmsAccess.Builder,KmsAccess>
@Generated("software.amazon.awssdk:codegen") public final class KmsAccess extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KmsAccess.Builder,KmsAccess>

Configuration for Amazon Web Services Key Management Service (KMS) access from the ODB network.

See Also:

  • Method Details

    • status

      public final ManagedResourceStatus status()

      The current status of the KMS access configuration.

      If the service returns an enum value that is not available in the current SDK version, status will return ManagedResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the KMS access configuration.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the KMS access configuration.

      If the service returns an enum value that is not available in the current SDK version, status will return ManagedResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the KMS access configuration.
      See Also:

    • hasIpv4Addresses

      public final boolean hasIpv4Addresses()
      For responses, this returns true if the service returned a value for the Ipv4Addresses 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.

    • ipv4Addresses

      public final List<String> ipv4Addresses()

      The IPv4 addresses allowed for KMS access.

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

      Returns:
      The IPv4 addresses allowed for KMS access.

    • domainName

      public final String domainName()

      The domain name for KMS access configuration.

      Returns:
      The domain name for KMS access configuration.

    • kmsPolicyDocument

      public final String kmsPolicyDocument()

      The KMS policy document that defines permissions for key usage.

      Returns:
      The KMS policy document that defines permissions for key usage.

    • toBuilder

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

    • builder

      public static KmsAccess.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.