@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
254 lines (253 loc) • 7.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of dnat entries
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooGateway = new volcengine.nat.Gateway("fooGateway", {
* vpcId: fooVpc.id,
* subnetId: fooSubnet.id,
* spec: "Small",
* natGatewayName: "acc-test-ng",
* description: "acc-test",
* billingType: "PostPaid",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooAddress = new volcengine.eip.Address("fooAddress", {
* description: "acc-test",
* bandwidth: 1,
* billingType: "PostPaidByBandwidth",
* isp: "BGP",
* });
* const fooAssociate = new volcengine.eip.Associate("fooAssociate", {
* allocationId: fooAddress.id,
* instanceId: fooGateway.id,
* instanceType: "Nat",
* });
* const fooDnatEntry = new volcengine.nat.DnatEntry("fooDnatEntry", {
* dnatEntryName: "acc-test-dnat-entry",
* externalIp: fooAddress.eipAddress,
* externalPort: "80",
* internalIp: "172.16.0.10",
* internalPort: "80",
* natGatewayId: fooGateway.id,
* protocol: "tcp",
* }, {
* dependsOn: [fooAssociate],
* });
* const fooDnatEntries = volcengine.nat.getDnatEntriesOutput({
* ids: [fooDnatEntry.id],
* });
* ```
*/
export declare function getDnatEntries(args?: GetDnatEntriesArgs, opts?: pulumi.InvokeOptions): Promise<GetDnatEntriesResult>;
/**
* A collection of arguments for invoking getDnatEntries.
*/
export interface GetDnatEntriesArgs {
/**
* The name of the DNAT entry.
*/
dnatEntryName?: string;
/**
* Provides the public IP address for public network access.
*/
externalIp?: string;
/**
* The port or port segment that receives requests from the public network. If InternalPort is passed into the port segment, ExternalPort must also be passed into the port segment.
*/
externalPort?: string;
/**
* A list of DNAT entry ids.
*/
ids?: string[];
/**
* Provides the internal IP address.
*/
internalIp?: string;
/**
* The port or port segment on which the cloud server instance provides services to the public network.
*/
internalPort?: string;
/**
* The id of the NAT gateway.
*/
natGatewayId?: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
/**
* The network protocol.
*/
protocol?: string;
}
/**
* A collection of values returned by getDnatEntries.
*/
export interface GetDnatEntriesResult {
/**
* List of DNAT entries.
*/
readonly dnatEntries: outputs.nat.GetDnatEntriesDnatEntry[];
/**
* The name of the DNAT entry.
*/
readonly dnatEntryName?: string;
/**
* Provides the public IP address for public network access.
*/
readonly externalIp?: string;
/**
* The port or port segment that receives requests from the public network. If InternalPort is passed into the port segment, ExternalPort must also be passed into the port segment.
*/
readonly externalPort?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ids?: string[];
/**
* Provides the internal IP address.
*/
readonly internalIp?: string;
/**
* The port or port segment on which the cloud server instance provides services to the public network.
*/
readonly internalPort?: string;
/**
* The ID of the NAT gateway.
*/
readonly natGatewayId?: string;
readonly outputFile?: string;
/**
* The network protocol.
*/
readonly protocol?: string;
/**
* The total count of snat entries query.
*/
readonly totalCount: number;
}
/**
* Use this data source to query detailed information of dnat entries
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooGateway = new volcengine.nat.Gateway("fooGateway", {
* vpcId: fooVpc.id,
* subnetId: fooSubnet.id,
* spec: "Small",
* natGatewayName: "acc-test-ng",
* description: "acc-test",
* billingType: "PostPaid",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooAddress = new volcengine.eip.Address("fooAddress", {
* description: "acc-test",
* bandwidth: 1,
* billingType: "PostPaidByBandwidth",
* isp: "BGP",
* });
* const fooAssociate = new volcengine.eip.Associate("fooAssociate", {
* allocationId: fooAddress.id,
* instanceId: fooGateway.id,
* instanceType: "Nat",
* });
* const fooDnatEntry = new volcengine.nat.DnatEntry("fooDnatEntry", {
* dnatEntryName: "acc-test-dnat-entry",
* externalIp: fooAddress.eipAddress,
* externalPort: "80",
* internalIp: "172.16.0.10",
* internalPort: "80",
* natGatewayId: fooGateway.id,
* protocol: "tcp",
* }, {
* dependsOn: [fooAssociate],
* });
* const fooDnatEntries = volcengine.nat.getDnatEntriesOutput({
* ids: [fooDnatEntry.id],
* });
* ```
*/
export declare function getDnatEntriesOutput(args?: GetDnatEntriesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDnatEntriesResult>;
/**
* A collection of arguments for invoking getDnatEntries.
*/
export interface GetDnatEntriesOutputArgs {
/**
* The name of the DNAT entry.
*/
dnatEntryName?: pulumi.Input<string>;
/**
* Provides the public IP address for public network access.
*/
externalIp?: pulumi.Input<string>;
/**
* The port or port segment that receives requests from the public network. If InternalPort is passed into the port segment, ExternalPort must also be passed into the port segment.
*/
externalPort?: pulumi.Input<string>;
/**
* A list of DNAT entry ids.
*/
ids?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Provides the internal IP address.
*/
internalIp?: pulumi.Input<string>;
/**
* The port or port segment on which the cloud server instance provides services to the public network.
*/
internalPort?: pulumi.Input<string>;
/**
* The id of the NAT gateway.
*/
natGatewayId?: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
/**
* The network protocol.
*/
protocol?: pulumi.Input<string>;
}