@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
162 lines • 4.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* For further information refer to the Site-to-Site VPN [API documentation](https://www.scaleway.com/en/developers/api/site-to-site-vpn/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by gateway ID
* const myGateway = scaleway.s2svpn.getGateway({
* vpnGatewayId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by name
* const myGateway = scaleway.s2svpn.getGateway({
* name: "foobar",
* });
* ```
*/
export declare function getGateway(args?: GetGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetGatewayResult>;
/**
* A collection of arguments for invoking getGateway.
*/
export interface GetGatewayArgs {
/**
* The name of the VPN gateway.
*/
name?: string;
/**
* The ID of the project the VPN gateway is associated with.
*/
projectId?: string;
/**
* `region`) The region in which the VPN gateway exists.
*/
region?: string;
/**
* The VPN gateway ID.
*
* > **Note** You must specify at least one: `name` and/or `vpnGatewayId`.
*/
vpnGatewayId?: string;
}
/**
* A collection of values returned by getGateway.
*/
export interface GetGatewayResult {
/**
* The AS Number of the VPN gateway.
*/
readonly asn: number;
/**
* The date and time of creation of the VPN gateway.
*/
readonly createdAt: string;
/**
* The VPN gateway type (commercial offer type).
*/
readonly gatewayType: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The ID of the IPAM private IPv4 address attached to the VPN gateway.
*/
readonly ipamPrivateIpv4Id: string;
/**
* The ID of the IPAM private IPv6 address attached to the VPN gateway.
*/
readonly ipamPrivateIpv6Id: string;
readonly name?: string;
/**
* The Organization ID the VPN gateway is associated with.
*/
readonly organizationId: string;
/**
* The ID of the Private Network attached to the VPN gateway.
*/
readonly privateNetworkId: string;
readonly projectId?: string;
/**
* The public endpoint configuration of the VPN gateway.
*/
readonly publicConfigs: outputs.s2svpn.GetGatewayPublicConfig[];
readonly region?: string;
/**
* The status of the VPN gateway.
*/
readonly status: string;
/**
* The tags associated with the VPN gateway.
*/
readonly tags: string[];
/**
* The date and time of the last update of the VPN gateway.
*/
readonly updatedAt: string;
readonly vpnGatewayId?: string;
/**
* The zone in which the VPN gateway is deployed.
*/
readonly zone: string;
}
/**
* For further information refer to the Site-to-Site VPN [API documentation](https://www.scaleway.com/en/developers/api/site-to-site-vpn/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by gateway ID
* const myGateway = scaleway.s2svpn.getGateway({
* vpnGatewayId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get info by name
* const myGateway = scaleway.s2svpn.getGateway({
* name: "foobar",
* });
* ```
*/
export declare function getGatewayOutput(args?: GetGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGatewayResult>;
/**
* A collection of arguments for invoking getGateway.
*/
export interface GetGatewayOutputArgs {
/**
* The name of the VPN gateway.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project the VPN gateway is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the VPN gateway exists.
*/
region?: pulumi.Input<string | undefined>;
/**
* The VPN gateway ID.
*
* > **Note** You must specify at least one: `name` and/or `vpnGatewayId`.
*/
vpnGatewayId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getGateway.d.ts.map