replicate_secret_to_regions ¶

def replicate_secret_to_regions(
    self,
    secret_id: "capo_secrets_manager.types.secret_id_type.SecretIdType",
    add_replica_regions: "capo_secrets_manager.types.add_replica_region_list_type.AddReplicaRegionListType",
    *,
    config_overrides: Optional[SecretsManagerClientConfig] = None,
    force_overwrite_replica_secret: Optional[
        "capo_secrets_manager.types.boolean_type.BooleanType"
    ] = None,
) -> "capo_secrets_manager.types.replicate_secret_to_regions_response.ReplicateSecretToRegionsResponse":
    """<p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p> <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p> <p> <b>Required permissions: </b> <code>secretsmanager:ReplicateSecretToRegions</code>. If the primary secret is encrypted with a KMS key other than <code>aws/secretsmanager</code>, you also need <code>kms:Decrypt</code> permission to the key. To encrypt the replicated secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Encrypt</code> to the key. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions"> IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control in Secrets Manager</a>. </p>

    Args:
        secret_id: <p>The ARN or name of the secret to replicate.</p>
        add_replica_regions: <p>A list of Regions in which to replicate the secret.</p>
        force_overwrite_replica_secret: <p>Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.</p>

    Raises:
        capo_secrets_manager.errors.internal_service_error.InternalServiceError: <p>An error occurred on the server side.</p>
        capo_secrets_manager.errors.invalid_parameter_exception.InvalidParameterException: <p>The parameter name or value is invalid.</p>
        capo_secrets_manager.errors.invalid_request_exception.InvalidRequestException: <p>A parameter value is not valid for the current state of the resource.</p> <p>Possible causes:</p> <ul> <li> <p>The secret is scheduled for deletion.</p> </li> <li> <p>You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. </p> </li> <li> <p>The secret is managed by another service, and you must use that service to update it. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p> </li> </ul>
        capo_secrets_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Secrets Manager can't find the resource that you asked for.</p>
        capo_secrets_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example
        The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.

        >>> client.replicate_secret_to_regions(secret_id='MyTestSecret', add_replica_regions=[{'Region': 'eu-west-3'}], force_overwrite_replica_secret=True)
    """

    def _handler(
        req: "OperationRequest[capo_secrets_manager.types.replicate_secret_to_regions_request.ReplicateSecretToRegionsRequest]",
    ) -> OperationResponse[
        "capo_secrets_manager.types.replicate_secret_to_regions_response.ReplicateSecretToRegionsResponse"
    ]:
        import capo_secrets_manager._operations.secretsmanager.replicate_secret_to_regions

        output, http_response = (
            capo_secrets_manager._operations.secretsmanager.replicate_secret_to_regions.replicate_secret_to_regions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReplicateSecretToRegions")
    )
    input_: capo_secrets_manager.types.replicate_secret_to_regions_request.ReplicateSecretToRegionsRequest = {
        "secret_id": secret_id,
        "add_replica_regions": add_replica_regions,
    }
    if force_overwrite_replica_secret is not None:
        input_["force_overwrite_replica_secret"] = force_overwrite_replica_secret

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output