@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
88 lines • 2.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about multiple Interlink Partners.
*
* A partner is an organization that provides shared connections at PoPs. Use this data source to list and filter available partners for creating hosted links.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // List all partners in a region
* const all = scaleway.interlink.getPartners({
* region: "fr-par",
* });
* // List partners available at specific PoPs
* const atPops = scaleway.interlink.getPartners({
* popIds: [main.id],
* });
* ```
*/
export declare function getPartners(args?: GetPartnersArgs, opts?: pulumi.InvokeOptions): Promise<GetPartnersResult>;
/**
* A collection of arguments for invoking getPartners.
*/
export interface GetPartnersArgs {
/**
* Filter for partners present (offering a connection) in one of these PoPs.
*/
popIds?: string[];
/**
* `region`) The region to list partners from.
*/
region?: string;
}
/**
* A collection of values returned by getPartners.
*/
export interface GetPartnersResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* List of partners matching the filters. Each entry contains:
*/
readonly partners: outputs.interlink.GetPartnersPartner[];
readonly popIds?: string[];
readonly region?: string;
}
/**
* Gets information about multiple Interlink Partners.
*
* A partner is an organization that provides shared connections at PoPs. Use this data source to list and filter available partners for creating hosted links.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // List all partners in a region
* const all = scaleway.interlink.getPartners({
* region: "fr-par",
* });
* // List partners available at specific PoPs
* const atPops = scaleway.interlink.getPartners({
* popIds: [main.id],
* });
* ```
*/
export declare function getPartnersOutput(args?: GetPartnersOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPartnersResult>;
/**
* A collection of arguments for invoking getPartners.
*/
export interface GetPartnersOutputArgs {
/**
* Filter for partners present (offering a connection) in one of these PoPs.
*/
popIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `region`) The region to list partners from.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getPartners.d.ts.map