@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
141 lines • 4.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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.getCustomerGateway({
* customerGatewayId: "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.getCustomerGateway({
* name: "foobar",
* });
* ```
*/
export declare function getCustomerGateway(args?: GetCustomerGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomerGatewayResult>;
/**
* A collection of arguments for invoking getCustomerGateway.
*/
export interface GetCustomerGatewayArgs {
/**
* The customer gateway ID.
*
* > **Note** You must specify at least one: `name` and/or `customerGatewayId`.
*/
customerGatewayId?: string;
/**
* The name of the customer gateway.
*/
name?: string;
/**
* The ID of the project the customer gateway is associated with.
*/
projectId?: string;
/**
* `region`) The region in which the customer gateway exists.
*/
region?: string;
}
/**
* A collection of values returned by getCustomerGateway.
*/
export interface GetCustomerGatewayResult {
/**
* The AS Number of the customer gateway.
*/
readonly asn: number;
/**
* The date and time of creation of the customer gateway.
*/
readonly createdAt: string;
readonly customerGatewayId?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The public IPv4 address of the customer gateway.
*/
readonly ipv4Public: string;
/**
* The public IPv6 address of the customer gateway.
*/
readonly ipv6Public: string;
readonly name?: string;
/**
* The Organization ID the customer gateway is associated with.
*/
readonly organizationId: string;
readonly projectId?: string;
readonly region?: string;
/**
* The tags associated with the customer gateway.
*/
readonly tags: string[];
/**
* The date and time of the last update of the customer gateway.
*/
readonly updatedAt: 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.getCustomerGateway({
* customerGatewayId: "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.getCustomerGateway({
* name: "foobar",
* });
* ```
*/
export declare function getCustomerGatewayOutput(args?: GetCustomerGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCustomerGatewayResult>;
/**
* A collection of arguments for invoking getCustomerGateway.
*/
export interface GetCustomerGatewayOutputArgs {
/**
* The customer gateway ID.
*
* > **Note** You must specify at least one: `name` and/or `customerGatewayId`.
*/
customerGatewayId?: pulumi.Input<string | undefined>;
/**
* The name of the customer gateway.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project the customer gateway is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the customer gateway exists.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getCustomerGateway.d.ts.map