@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
149 lines • 4.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about an Interlink Dedicated Connection.
*
* A dedicated connection is a physical connection owned by the user at a PoP, used to create self-hosted links between your infrastructure and Scaleway.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a dedicated connection by its ID
* const byId = scaleway.interlink.getDedicatedConnection({
* connectionId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a dedicated connection by name
* const byName = scaleway.interlink.getDedicatedConnection({
* name: "my-dedicated-connection",
* });
* ```
*/
export declare function getDedicatedConnection(args?: GetDedicatedConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetDedicatedConnectionResult>;
/**
* A collection of arguments for invoking getDedicatedConnection.
*/
export interface GetDedicatedConnectionArgs {
/**
* The ID of the dedicated connection. Can be a plain UUID or a regional ID. Conflicts with `name`.
*/
connectionId?: string;
/**
* The name of the dedicated connection to filter for. Conflicts with `connectionId`.
*/
name?: string;
/**
* `region`) The region in which the dedicated connection exists.
*/
region?: string;
}
/**
* A collection of values returned by getDedicatedConnection.
*/
export interface GetDedicatedConnectionResult {
/**
* Sizes of the links supported on this dedicated connection.
*/
readonly availableLinkBandwidths: number[];
/**
* Bandwidth size of the dedicated connection in Mbps.
*/
readonly bandwidthMbps: number;
readonly connectionId?: string;
/**
* Creation date of the dedicated connection (RFC 3339 format).
*/
readonly createdAt: string;
/**
* Demarcation details required by the data center to set up the Cross Connect.
*/
readonly demarcationInfo: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
/**
* The ID of the organization the dedicated connection belongs to.
*/
readonly organizationId: string;
/**
* ID of the PoP where the dedicated connection is located.
*/
readonly popId: string;
/**
* The ID of the project the dedicated connection belongs to.
*/
readonly projectId: string;
readonly region?: string;
/**
* Status of the dedicated connection.
*/
readonly status: string;
/**
* List of tags associated with the dedicated connection.
*/
readonly tags: string[];
/**
* Last modification date of the dedicated connection (RFC 3339 format).
*/
readonly updatedAt: string;
/**
* VLAN range for self-hosted links. Contains `start` and `end`.
*/
readonly vlanRanges: outputs.interlink.GetDedicatedConnectionVlanRange[];
}
/**
* Gets information about an Interlink Dedicated Connection.
*
* A dedicated connection is a physical connection owned by the user at a PoP, used to create self-hosted links between your infrastructure and Scaleway.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a dedicated connection by its ID
* const byId = scaleway.interlink.getDedicatedConnection({
* connectionId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Retrieve a dedicated connection by name
* const byName = scaleway.interlink.getDedicatedConnection({
* name: "my-dedicated-connection",
* });
* ```
*/
export declare function getDedicatedConnectionOutput(args?: GetDedicatedConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDedicatedConnectionResult>;
/**
* A collection of arguments for invoking getDedicatedConnection.
*/
export interface GetDedicatedConnectionOutputArgs {
/**
* The ID of the dedicated connection. Can be a plain UUID or a regional ID. Conflicts with `name`.
*/
connectionId?: pulumi.Input<string | undefined>;
/**
* The name of the dedicated connection to filter for. Conflicts with `connectionId`.
*/
name?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the dedicated connection exists.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getDedicatedConnection.d.ts.map