Class SecretsManagerSecretConfiguration

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

The configuration for a Secrets Manager secret. For more information, see CreateSecret.

You can propose a configuration for a new secret or an existing secret that you own by specifying the secret policy and optional KMS encryption key. If the configuration is for an existing secret and you do not specify the secret policy, the access preview uses the existing policy for the secret. If the access preview is for a new resource and you do not specify the policy, the access preview assumes a secret without a policy. To propose deletion of an existing policy, you can specify an empty string. If the proposed configuration is for a new secret and you do not specify the KMS key ID, the access preview uses the Amazon Web Services managed key aws/secretsmanager. If you specify an empty string for the KMS key ID, the access preview uses the Amazon Web Services managed key of the Amazon Web Services account. For more information about secret policy limits, see Quotas for Secrets Manager..

See Also:

  • Method Details

    • kmsKeyId

      public final String kmsKeyId()

      The proposed ARN, key ID, or alias of the KMS key.

      Returns:
      The proposed ARN, key ID, or alias of the KMS key.

    • secretPolicy

      public final String secretPolicy()

      The proposed resource policy defining who can access or manage the secret.

      Returns:
      The proposed resource policy defining who can access or manage the secret.

    • toBuilder

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

    • builder

      public static SecretsManagerSecretConfiguration.Builder builder()

    • serializableBuilderClass

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