@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
134 lines (133 loc) • 4.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Gets information about a gateway network.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
* import * as scaleway from "@pulumi/scaleway";
*
* const main = new scaleway.VpcGatewayNetwork("main", {
* gatewayId: scaleway_vpc_public_gateway.pg01.id,
* privateNetworkId: scaleway_vpc_private_network.pn01.id,
* dhcpId: scaleway_vpc_public_gateway_dhcp.dhcp01.id,
* cleanupDhcp: true,
* enableMasquerade: true,
* });
* const byId = scaleway.getVpcGatewayNetworkOutput({
* gatewayNetworkId: main.id,
* });
* const byGatewayAndPn = scaleway.getVpcGatewayNetwork({
* gatewayId: scaleway_vpc_public_gateway.pg01.id,
* privateNetworkId: scaleway_vpc_private_network.pn01.id,
* });
* ```
*/
export declare function getVpcGatewayNetwork(args?: GetVpcGatewayNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcGatewayNetworkResult>;
/**
* A collection of arguments for invoking getVpcGatewayNetwork.
*/
export interface GetVpcGatewayNetworkArgs {
/**
* ID of the public gateway DHCP config
*/
dhcpId?: string;
/**
* If masquerade is enabled on requested network
*/
enableMasquerade?: boolean;
/**
* ID of the public gateway the gateway network is linked to
*/
gatewayId?: string;
/**
* ID of the gateway network.
*
* > Only one of `gatewayNetworkId` or filters should be specified. You can use all the filters you want.
*/
gatewayNetworkId?: string;
/**
* ID of the private network the gateway network is linked to
*/
privateNetworkId?: string;
}
/**
* A collection of values returned by getVpcGatewayNetwork.
*/
export interface GetVpcGatewayNetworkResult {
readonly cleanupDhcp: boolean;
readonly createdAt: string;
readonly dhcpId?: string;
readonly enableDhcp: boolean;
readonly enableMasquerade?: boolean;
readonly gatewayId?: string;
readonly gatewayNetworkId?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ipamConfigs: outputs.GetVpcGatewayNetworkIpamConfig[];
readonly macAddress: string;
readonly privateNetworkId?: string;
readonly staticAddress: string;
readonly status: string;
readonly updatedAt: string;
readonly zone: string;
}
/**
* Gets information about a gateway network.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
* import * as scaleway from "@pulumi/scaleway";
*
* const main = new scaleway.VpcGatewayNetwork("main", {
* gatewayId: scaleway_vpc_public_gateway.pg01.id,
* privateNetworkId: scaleway_vpc_private_network.pn01.id,
* dhcpId: scaleway_vpc_public_gateway_dhcp.dhcp01.id,
* cleanupDhcp: true,
* enableMasquerade: true,
* });
* const byId = scaleway.getVpcGatewayNetworkOutput({
* gatewayNetworkId: main.id,
* });
* const byGatewayAndPn = scaleway.getVpcGatewayNetwork({
* gatewayId: scaleway_vpc_public_gateway.pg01.id,
* privateNetworkId: scaleway_vpc_private_network.pn01.id,
* });
* ```
*/
export declare function getVpcGatewayNetworkOutput(args?: GetVpcGatewayNetworkOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetVpcGatewayNetworkResult>;
/**
* A collection of arguments for invoking getVpcGatewayNetwork.
*/
export interface GetVpcGatewayNetworkOutputArgs {
/**
* ID of the public gateway DHCP config
*/
dhcpId?: pulumi.Input<string>;
/**
* If masquerade is enabled on requested network
*/
enableMasquerade?: pulumi.Input<boolean>;
/**
* ID of the public gateway the gateway network is linked to
*/
gatewayId?: pulumi.Input<string>;
/**
* ID of the gateway network.
*
* > Only one of `gatewayNetworkId` or filters should be specified. You can use all the filters you want.
*/
gatewayNetworkId?: pulumi.Input<string>;
/**
* ID of the private network the gateway network is linked to
*/
privateNetworkId?: pulumi.Input<string>;
}