Class CrossAccountReplicaEntry

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

Information about a cross-account replica secret. This information is only available for cross-account primary secrets.

See Also:

  • Method Details

    • replicaSecretARN

      public final String replicaSecretARN()

      The ARN of the replica secret.

      Returns:
      The ARN of the replica secret.

    • replicationRoleARN

      public final String replicationRoleARN()

      The ARN of the IAM role that Secrets Manager assumes to replicate to this replica, if one was specified when the replica was associated.

      Returns:
      The ARN of the IAM role that Secrets Manager assumes to replicate to this replica, if one was specified when the replica was associated.

    • replicationStatus

      public final StatusType replicationStatus()

      The status of replication from this primary secret. The status can be:

      • InSync: Replication from the primary secret is complete.

      • Failed: Replication from the primary secret was unable to be completed.

      • InProgress: Replication from the primary secret has started but is not complete.

      • Detached: Replication from the primary secret was stopped by the replica.

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

      Returns:
      The status of replication from this primary secret. The status can be:

      • InSync: Replication from the primary secret is complete.

      • Failed: Replication from the primary secret was unable to be completed.

      • InProgress: Replication from the primary secret has started but is not complete.

      • Detached: Replication from the primary secret was stopped by the replica.

      See Also:

    • replicationStatusAsString

      public final String replicationStatusAsString()

      The status of replication from this primary secret. The status can be:

      • InSync: Replication from the primary secret is complete.

      • Failed: Replication from the primary secret was unable to be completed.

      • InProgress: Replication from the primary secret has started but is not complete.

      • Detached: Replication from the primary secret was stopped by the replica.

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

      Returns:
      The status of replication from this primary secret. The status can be:

      • InSync: Replication from the primary secret is complete.

      • Failed: Replication from the primary secret was unable to be completed.

      • InProgress: Replication from the primary secret has started but is not complete.

      • Detached: Replication from the primary secret was stopped by the replica.

      See Also:

    • statusMessage

      public final String statusMessage()

      A message that describes the replication status, if Secrets Manager has more information to provide.

      Returns:
      A message that describes the replication status, if Secrets Manager has more information to provide.

    • toBuilder

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

    • builder

      public static CrossAccountReplicaEntry.Builder builder()

    • serializableBuilderClass

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