@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface Vpc_peeringsRequestBuilder

    Builds and executes requests for operations under /v2/vpc_peerings

    interface Vpc_peeringsRequestBuilder {
        byVpc_peering_id(
            vpc_peering_id: string,
        ): WithVpc_peering_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Vpc_peeringsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Vpc_peeringsGetResponse>;
        post(
            body: Vpc_peeringsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Vpc_peeringsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Vpc_peeringsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Vpc_peeringsPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Vpc_peeringsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byVpc_peering_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Vpc_peeringsPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Vpc_peeringsPostResponse>

      To create a new VPC Peering, send a POST request to /v2/vpc_peerings specifying a name and a list of two VPC IDs to peer. The response code, 202 Accepted, does not indicate the success or failure of the operation, just that the request has been accepted for processing.

      Parameters

      • body: Vpc_peeringsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | Vpc_peeringsPostResponse>

      error when the service returns a 401 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To create a new VPC Peering, send a POST request to /v2/vpc_peerings specifying a name and a list of two VPC IDs to peer. The response code, 202 Accepted, does not indicate the success or failure of the operation, just that the request has been accepted for processing.

      Parameters

      • body: Vpc_peeringsPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods