Skip to content

update_kx_environment_network async

update_kx_environment_network(
    environment_id: IdType,
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    transit_gateway_configuration: Optional[TransitGatewayConfiguration] = None,
    custom_dns_configuration: Optional[CustomDNSConfiguration] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateKxEnvironmentNetworkResponse

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.

Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

Parameters:

  • environment_id (IdType) –

    A unique identifier for the kdb environment.

  • transit_gateway_configuration (Optional[TransitGatewayConfiguration], default: None ) –

    Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

  • custom_dns_configuration (Optional[CustomDNSConfiguration], default: None ) –

    A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

  • client_token (Optional[ClientToken], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

Raises:

Source code in docs_src/capo_finspace/_services/async_finspace.py
async def update_kx_environment_network(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    transit_gateway_configuration: Optional[
        "capo_finspace.types.transit_gateway_configuration.TransitGatewayConfiguration"
    ] = None,
    custom_dns_configuration: Optional[
        "capo_finspace.types.custom_dns_configuration.CustomDNSConfiguration"
    ] = None,
    client_token: Optional["capo_finspace.types.client_token.ClientToken"] = None,
) -> "capo_finspace.types.update_kx_environment_network_response.UpdateKxEnvironmentNetworkResponse":
    """<p>Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.</p> <p>Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        transit_gateway_configuration: <p>Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.</p>
        custom_dns_configuration: <p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.update_kx_environment_network_request.UpdateKxEnvironmentNetworkRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.update_kx_environment_network_response.UpdateKxEnvironmentNetworkResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_environment_network

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.update_kx_environment_network.async_update_kx_environment_network(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxEnvironmentNetwork")
    )
    input_: capo_finspace.types.update_kx_environment_network_request.UpdateKxEnvironmentNetworkRequest = {
        "environment_id": environment_id
    }
    if transit_gateway_configuration is not None:
        input_["transit_gateway_configuration"] = transit_gateway_configuration
    if custom_dns_configuration is not None:
        input_["custom_dns_configuration"] = custom_dns_configuration
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output