@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
225 lines (224 loc) • 8.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an SNAT rule resource of the **public** NAT within HuaweiCloud.
*
* ## Example Usage
*
* ## Import
*
* The SNAT rule can be imported using `id`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Nat/snatRule:SnatRule test <id>
* ```
*/
export declare class SnatRule extends pulumi.CustomResource {
/**
* Get an existing SnatRule 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?: SnatRuleState, opts?: pulumi.CustomResourceOptions): SnatRule;
/**
* Returns true if the given object is an instance of SnatRule. 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 SnatRule;
/**
* Specifies the CIDR block connected by SNAT rule (DC side).
* This parameter and `subnetId` are alternative. Changing this will create a new resource.
*/
readonly cidr: pulumi.Output<string | undefined>;
/**
* The creation time of the SNAT rule.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Specifies the description of the SNAT rule.
* The value is a string of no more than `255` characters, and angle brackets (<>) are not allowed.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The actual floating IP address.
*/
readonly floatingIpAddress: pulumi.Output<string>;
/**
* Specifies the IDs of floating IPs connected by SNAT rule.
* Multiple floating IPs are separated using commas (,). The number of floating IP IDs cannot exceed `20`.
*/
readonly floatingIpId: pulumi.Output<string>;
/**
* The frozen EIP associated with the SNAT rule.
*/
readonly freezedIpAddress: pulumi.Output<string>;
/**
* The global EIP addresses (separated by commas) connected by SNAT rule.
*/
readonly globalEipAddress: pulumi.Output<string>;
/**
* Specifies the IDs of global EIPs connected by SNAT rule.
* Multiple global EIPs are separated using commas (,). The number of global EIP IDs cannot exceed `20`.
*/
readonly globalEipId: pulumi.Output<string>;
/**
* Specifies the ID of the gateway to which the SNAT rule belongs.
* Changing this will create a new resource.
*/
readonly natGatewayId: pulumi.Output<string>;
/**
* @deprecated schema: Deprecated; Use 'subnet_id' instead.
*/
readonly networkId: pulumi.Output<string | undefined>;
/**
* Specifies the region where the SNAT rule is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the resource scenario.
* The valid values are `0` (VPC scenario) and `1` (Direct Connect scenario), and the default value is `0`.
* Only `cidr` can be specified over a Direct Connect connection. Changing this will create a new resource.
*/
readonly sourceType: pulumi.Output<number | undefined>;
/**
* The status of the SNAT rule.
*/
readonly status: pulumi.Output<string>;
/**
* Specifies the network IDs of subnet connected by SNAT rule (VPC side).
* This parameter and `cidr` are alternative. Changing this will create a new resource.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Create a SnatRule 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: SnatRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SnatRule resources.
*/
export interface SnatRuleState {
/**
* Specifies the CIDR block connected by SNAT rule (DC side).
* This parameter and `subnetId` are alternative. Changing this will create a new resource.
*/
cidr?: pulumi.Input<string>;
/**
* The creation time of the SNAT rule.
*/
createdAt?: pulumi.Input<string>;
/**
* Specifies the description of the SNAT rule.
* The value is a string of no more than `255` characters, and angle brackets (<>) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* The actual floating IP address.
*/
floatingIpAddress?: pulumi.Input<string>;
/**
* Specifies the IDs of floating IPs connected by SNAT rule.
* Multiple floating IPs are separated using commas (,). The number of floating IP IDs cannot exceed `20`.
*/
floatingIpId?: pulumi.Input<string>;
/**
* The frozen EIP associated with the SNAT rule.
*/
freezedIpAddress?: pulumi.Input<string>;
/**
* The global EIP addresses (separated by commas) connected by SNAT rule.
*/
globalEipAddress?: pulumi.Input<string>;
/**
* Specifies the IDs of global EIPs connected by SNAT rule.
* Multiple global EIPs are separated using commas (,). The number of global EIP IDs cannot exceed `20`.
*/
globalEipId?: pulumi.Input<string>;
/**
* Specifies the ID of the gateway to which the SNAT rule belongs.
* Changing this will create a new resource.
*/
natGatewayId?: pulumi.Input<string>;
/**
* @deprecated schema: Deprecated; Use 'subnet_id' instead.
*/
networkId?: pulumi.Input<string>;
/**
* Specifies the region where the SNAT rule is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the resource scenario.
* The valid values are `0` (VPC scenario) and `1` (Direct Connect scenario), and the default value is `0`.
* Only `cidr` can be specified over a Direct Connect connection. Changing this will create a new resource.
*/
sourceType?: pulumi.Input<number>;
/**
* The status of the SNAT rule.
*/
status?: pulumi.Input<string>;
/**
* Specifies the network IDs of subnet connected by SNAT rule (VPC side).
* This parameter and `cidr` are alternative. Changing this will create a new resource.
*/
subnetId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SnatRule resource.
*/
export interface SnatRuleArgs {
/**
* Specifies the CIDR block connected by SNAT rule (DC side).
* This parameter and `subnetId` are alternative. Changing this will create a new resource.
*/
cidr?: pulumi.Input<string>;
/**
* Specifies the description of the SNAT rule.
* The value is a string of no more than `255` characters, and angle brackets (<>) are not allowed.
*/
description?: pulumi.Input<string>;
/**
* Specifies the IDs of floating IPs connected by SNAT rule.
* Multiple floating IPs are separated using commas (,). The number of floating IP IDs cannot exceed `20`.
*/
floatingIpId?: pulumi.Input<string>;
/**
* Specifies the IDs of global EIPs connected by SNAT rule.
* Multiple global EIPs are separated using commas (,). The number of global EIP IDs cannot exceed `20`.
*/
globalEipId?: pulumi.Input<string>;
/**
* Specifies the ID of the gateway to which the SNAT rule belongs.
* Changing this will create a new resource.
*/
natGatewayId: pulumi.Input<string>;
/**
* @deprecated schema: Deprecated; Use 'subnet_id' instead.
*/
networkId?: pulumi.Input<string>;
/**
* Specifies the region where the SNAT rule is located.
* If omitted, the provider-level region will be used. Changing this will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the resource scenario.
* The valid values are `0` (VPC scenario) and `1` (Direct Connect scenario), and the default value is `0`.
* Only `cidr` can be specified over a Direct Connect connection. Changing this will create a new resource.
*/
sourceType?: pulumi.Input<number>;
/**
* Specifies the network IDs of subnet connected by SNAT rule (VPC side).
* This parameter and `cidr` are alternative. Changing this will create a new resource.
*/
subnetId?: pulumi.Input<string>;
}