@lbrlabs/pulumi-scaleway/vpcPublicGatewayPatRule.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages Scaleway VPC Public Gateway PAT (Port Address Translation).
 * For more information, see [the documentation](https://developers.scaleway.com/en/products/vpc-gw/api/v1#pat-rules-e75d10).
 *
 * ## Example
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@lbrlabs/pulumi-scaleway";
 *
 * const pg01 = new scaleway.VpcPublicGateway("pg01", {type: "VPC-GW-S"});
 * const dhcp01 = new scaleway.VpcPublicGatewayDhcp("dhcp01", {subnet: "192.168.1.0/24"});
 * const pn01 = new scaleway.VpcPrivateNetwork("pn01", {});
 * const gn01 = new scaleway.VpcGatewayNetwork("gn01", {
 *     gatewayId: pg01.id,
 *     privateNetworkId: pn01.id,
 *     dhcpId: dhcp01.id,
 *     cleanupDhcp: true,
 * });
 * const main = new scaleway.VpcPublicGatewayPatRule("main", {
 *     gatewayId: pg01.id,
 *     privateIp: dhcp01.address,
 *     privatePort: 42,
 *     publicPort: 42,
 *     protocol: "both",
 * }, {
 *     dependsOn: [
 *         gn01,
 *         pn01,
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * Public gateway PAT rules config can be imported using the `{zone}/{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/vpcPublicGatewayPatRule:VpcPublicGatewayPatRule main fr-par-1/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class VpcPublicGatewayPatRule extends pulumi.CustomResource {
    /**
     * Get an existing VpcPublicGatewayPatRule resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcPublicGatewayPatRuleState, opts?: pulumi.CustomResourceOptions): VpcPublicGatewayPatRule;
    /**
     * Returns true if the given object is an instance of VpcPublicGatewayPatRule.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is VpcPublicGatewayPatRule;
    /**
     * The date and time of the creation of the pat rule config.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The ID of the public gateway.
     */
    readonly gatewayId: pulumi.Output<string>;
    /**
     * The organization ID the pat rule config is associated with.
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * The Private IP to forward data to (IP address).
     */
    readonly privateIp: pulumi.Output<string>;
    /**
     * The Private port to translate to.
     */
    readonly privatePort: pulumi.Output<number>;
    /**
     * The Protocol the rule should apply to. Possible values are both, tcp and udp.
     */
    readonly protocol: pulumi.Output<string | undefined>;
    /**
     * The Public port to listen on.
     */
    readonly publicPort: pulumi.Output<number>;
    /**
     * The date and time of the last update of the pat rule config.
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * `zone`) The zone in which the public gateway DHCP config should be created.
     */
    readonly zone: pulumi.Output<string>;
    /**
     * Create a VpcPublicGatewayPatRule resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: VpcPublicGatewayPatRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering VpcPublicGatewayPatRule resources.
 */
export interface VpcPublicGatewayPatRuleState {
    /**
     * The date and time of the creation of the pat rule config.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The ID of the public gateway.
     */
    gatewayId?: pulumi.Input<string>;
    /**
     * The organization ID the pat rule config is associated with.
     */
    organizationId?: pulumi.Input<string>;
    /**
     * The Private IP to forward data to (IP address).
     */
    privateIp?: pulumi.Input<string>;
    /**
     * The Private port to translate to.
     */
    privatePort?: pulumi.Input<number>;
    /**
     * The Protocol the rule should apply to. Possible values are both, tcp and udp.
     */
    protocol?: pulumi.Input<string>;
    /**
     * The Public port to listen on.
     */
    publicPort?: pulumi.Input<number>;
    /**
     * The date and time of the last update of the pat rule config.
     */
    updatedAt?: pulumi.Input<string>;
    /**
     * `zone`) The zone in which the public gateway DHCP config should be created.
     */
    zone?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a VpcPublicGatewayPatRule resource.
 */
export interface VpcPublicGatewayPatRuleArgs {
    /**
     * The ID of the public gateway.
     */
    gatewayId: pulumi.Input<string>;
    /**
     * The Private IP to forward data to (IP address).
     */
    privateIp: pulumi.Input<string>;
    /**
     * The Private port to translate to.
     */
    privatePort: pulumi.Input<number>;
    /**
     * The Protocol the rule should apply to. Possible values are both, tcp and udp.
     */
    protocol?: pulumi.Input<string>;
    /**
     * The Public port to listen on.
     */
    publicPort: pulumi.Input<number>;
    /**
     * `zone`) The zone in which the public gateway DHCP config should be created.
     */
    zone?: pulumi.Input<string>;
}