Skip to content

update_global_resolver

update_global_resolver(
    global_resolver_id: ResourceId,
    *,
    config_overrides: Optional[Route53GlobalResolverClientConfig] = None,
    name: Optional[ResourceName] = None,
    observability_region: Optional[Region] = None,
    description: Optional[ResourceDescription] = None,
    ip_address_type: Optional[GlobalResolverIpAddressType] = None,
    regions: Optional[Regions] = None,
) -> UpdateGlobalResolverOutput

Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region.

Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

Parameters:

  • global_resolver_id (ResourceId) –

    The ID of the Global Resolver.

  • name (Optional[ResourceName], default: None ) –

    The name of the Global Resolver.

  • observability_region (Optional[Region], default: None ) –

    The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.

  • description (Optional[ResourceDescription], default: None ) –

    The description of the Global Resolver.

  • ip_address_type (Optional[GlobalResolverIpAddressType], default: None ) –

    The IP address type for the Global Resolver. Valid values are IPV4 or DUAL_STACK for both IPv4 and IPv6 support.

  • regions (Optional[Regions], default: None ) –

    The list of Amazon Web Services Regions where the Global Resolver will operate. The resolver will be distributed across these Regions to provide global availability and low-latency DNS resolution.

Raises:

  • AccessDeniedException –

    You don't have permission to perform this operation. Check your IAM permissions and try again.

  • ConflictException –

    The request conflicts with the current state of the resource. This can occur when trying to modify a resource that is not in a valid state for the requested operation.

  • InternalServerException –

    An internal server error occurred. Try again later.

  • ResourceNotFoundException –

    The specified resource was not found. Verify the resource ID and try again.

  • ServiceQuotaExceededException –

    The request would exceed one or more service quotas. Check your current usage and quotas, then try again.

  • ThrottlingException –

    The request was throttled due to too many requests. Wait a moment and try again.

  • ValidationException –

    The input parameters are invalid. Check the parameter values and try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_route53globalresolver/_services/route53_global_resolver.py
def update_global_resolver(
    self,
    global_resolver_id: "capo_route53globalresolver.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[Route53GlobalResolverClientConfig] = None,
    name: Optional[
        "capo_route53globalresolver.types.resource_name.ResourceName"
    ] = None,
    observability_region: Optional[
        "capo_route53globalresolver.types.region.Region"
    ] = None,
    description: Optional[
        "capo_route53globalresolver.types.resource_description.ResourceDescription"
    ] = None,
    ip_address_type: Optional[
        "capo_route53globalresolver.types.global_resolver_ip_address_type.GlobalResolverIpAddressType"
    ] = None,
    regions: Optional["capo_route53globalresolver.types.regions.Regions"] = None,
) -> "capo_route53globalresolver.types.update_global_resolver_output.UpdateGlobalResolverOutput":
    """<p>Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region.</p> <important> <p>Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify <code>--region us-east-2</code> on Amazon Web Services CLI commands.</p> </important>

    Args:
        global_resolver_id: <p>The ID of the Global Resolver.</p>
        name: <p>The name of the Global Resolver.</p>
        observability_region: <p>The Amazon Web Services Regions in which the users' Global Resolver query resolution logs will be propagated.</p>
        description: <p>The description of the Global Resolver.</p>
        ip_address_type: <p>The IP address type for the Global Resolver. Valid values are IPV4 or DUAL_STACK for both IPv4 and IPv6 support.</p>
        regions: <p>The list of Amazon Web Services Regions where the Global Resolver will operate. The resolver will be distributed across these Regions to provide global availability and low-latency DNS resolution.</p>

    Raises:
        capo_route53globalresolver.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform this operation. Check your IAM permissions and try again.</p>
        capo_route53globalresolver.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. This can occur when trying to modify a resource that is not in a valid state for the requested operation.</p>
        capo_route53globalresolver.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Try again later.</p>
        capo_route53globalresolver.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify the resource ID and try again.</p>
        capo_route53globalresolver.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed one or more service quotas. Check your current usage and quotas, then try again.</p>
        capo_route53globalresolver.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Wait a moment and try again.</p>
        capo_route53globalresolver.errors.validation_exception.ValidationException: <p>The input parameters are invalid. Check the parameter values and try again.</p>
        capo_route53globalresolver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route53globalresolver.types.update_global_resolver_input.UpdateGlobalResolverInput]",
    ) -> OperationResponse[
        "capo_route53globalresolver.types.update_global_resolver_output.UpdateGlobalResolverOutput"
    ]:
        import capo_route53globalresolver._operations.ec2_dns_global_resolver_customer_api.update_global_resolver

        output, http_response = (
            capo_route53globalresolver._operations.ec2_dns_global_resolver_customer_api.update_global_resolver.update_global_resolver(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGlobalResolver")
    )
    input_: capo_route53globalresolver.types.update_global_resolver_input.UpdateGlobalResolverInput = {
        "global_resolver_id": global_resolver_id
    }
    if name is not None:
        input_["name"] = name
    if observability_region is not None:
        input_["observability_region"] = observability_region
    if description is not None:
        input_["description"] = description
    if ip_address_type is not None:
        input_["ip_address_type"] = ip_address_type
    if regions is not None:
        input_["regions"] = regions

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