Class AssociateCrossAccountReplicaRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
software.amazon.awssdk.services.secretsmanager.model.AssociateCrossAccountReplicaRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AssociateCrossAccountReplicaRequest.Builder,AssociateCrossAccountReplicaRequest>
@Generated("software.amazon.awssdk:codegen") public final class AssociateCrossAccountReplicaRequest extends SecretsManagerRequest implements ToCopyableBuilder<AssociateCrossAccountReplicaRequest.Builder,AssociateCrossAccountReplicaRequest>

  • Method Details

    • secretId

      public final String secretId()

      The ARN or name of the primary secret in your account to replicate.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Returns:
      The ARN or name of the primary secret in your account to replicate.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • crossAccountReplicaARN

      public final String crossAccountReplicaARN()

      The ARN of the replica secret in the other Amazon Web Services account. The replica secret must be in the same Region and partition as the primary secret. Additionally, the replica account owner must have created the replica secret as a cross-account replica of the primary secret. For more information see CreateSecret.

      Returns:
      The ARN of the replica secret in the other Amazon Web Services account. The replica secret must be in the same Region and partition as the primary secret. Additionally, the replica account owner must have created the replica secret as a cross-account replica of the primary secret. For more information see CreateSecret.

    • replicaRestriction

      public final ReplicaRestrictionType replicaRestriction()

      Whether the replica account must belong to the same Amazon Web Services organization as the primary account:

      • SameOrg, which requires the replica account to be in the same organization as the primary account. This is the default.

      • NoRestriction, which allows the replica account to be in any organization.

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

      Returns:
      Whether the replica account must belong to the same Amazon Web Services organization as the primary account:

      • SameOrg, which requires the replica account to be in the same organization as the primary account. This is the default.

      • NoRestriction, which allows the replica account to be in any organization.

      See Also:

    • replicaRestrictionAsString

      public final String replicaRestrictionAsString()

      Whether the replica account must belong to the same Amazon Web Services organization as the primary account:

      • SameOrg, which requires the replica account to be in the same organization as the primary account. This is the default.

      • NoRestriction, which allows the replica account to be in any organization.

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

      Returns:
      Whether the replica account must belong to the same Amazon Web Services organization as the primary account:

      • SameOrg, which requires the replica account to be in the same organization as the primary account. This is the default.

      • NoRestriction, which allows the replica account to be in any organization.

      See Also:

    • replicationRoleARN

      public final String replicationRoleARN()

      The ARN of an IAM role in the primary account that Secrets Manager assumes to perform replication. If you don't include this field, Secrets Manager replicates using the credentials of caller who updates the primary secret. For more information, see Cross-account replication permissions.

      Returns:
      The ARN of an IAM role in the primary account that Secrets Manager assumes to perform replication. If you don't include this field, Secrets Manager replicates using the credentials of caller who updates the primary secret. For more information, see Cross-account replication permissions.

    • toBuilder

      public AssociateCrossAccountReplicaRequest.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<AssociateCrossAccountReplicaRequest.Builder,AssociateCrossAccountReplicaRequest>
      Specified by:
      toBuilder in class SecretsManagerRequest
      Returns:
      a builder for type T

    • builder

      public static AssociateCrossAccountReplicaRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssociateCrossAccountReplicaRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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