Record Class UpdateSecretOptions

java.lang.Object
java.lang.Record
codes.grow.packages.awssecretsmanager.UpdateSecretOptions
Record Components:
value - New value: String → SecretString, byte[] → SecretBinary, anything else JSON-encoded.
description - New description.
kmsKeyId - New KMS key id, ARN or alias.
clientRequestToken - Idempotency token; the AWS SDK fills one when unset.

public record UpdateSecretOptions(Object value, String description, String kmsKeyId, String clientRequestToken) extends Record
Options of updateSecret; a new version is created only when a value is given.

Every component is optional: null means "not set" (the AWS default applies).

  • Constructor Details

    • UpdateSecretOptions

      public UpdateSecretOptions(Object value, String description, String kmsKeyId, String clientRequestToken)
      Creates an instance of a UpdateSecretOptions record class.
      Parameters:
      value - the value for the value record component
      description - the value for the description record component
      kmsKeyId - the value for the kmsKeyId record component
      clientRequestToken - the value for the clientRequestToken record component
  • Method Details

    • none

      public static UpdateSecretOptions none()
      Returns options with every field unset.
      Returns:
      empty options
    • builder

      public static UpdateSecretOptions.Builder builder()
      Starts a builder.
      Returns:
      a new builder
    • toBuilder

      public UpdateSecretOptions.Builder toBuilder()
      Returns a builder pre-filled with these options.
      Returns:
      a new builder
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • value

      public Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • kmsKeyId

      public String kmsKeyId()
      Returns the value of the kmsKeyId record component.
      Returns:
      the value of the kmsKeyId record component
    • clientRequestToken

      public String clientRequestToken()
      Returns the value of the clientRequestToken record component.
      Returns:
      the value of the clientRequestToken record component