pulumi-alicloud-kotlin/com.pulumi.alicloud.vpn.kotlin/VpnFunctions/getGateways

getGateways

suspend fun getGateways(argument: GetGatewaysPlainArgs): GetGatewaysResult

The VPNs data source lists a number of VPNs resource information owned by an Alicloud account.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpn.VpnFunctions;
import com.pulumi.alicloud.vpn.inputs.GetGatewaysArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var vpnGateways = VpnFunctions.getGateways(GetGatewaysArgs.builder()
            .businessStatus("Normal")
            .ids(
                "fake-vpn-id1",
                "fake-vpn-id2")
            .includeReservationData(true)
            .nameRegex("testAcc*")
            .outputFile("/tmp/vpns")
            .status("Active")
            .vpcId("fake-vpc-id")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getGateways.

Parameters

argument

A collection of arguments for invoking getGateways.

suspend fun getGateways(businessStatus: String? = null, enableIpsec: Boolean? = null, ids: List<String>? = null, includeReservationData: Boolean? = null, nameRegex: String? = null, outputFile: String? = null, status: String? = null, vpcId: String? = null): GetGatewaysResult

Return

A collection of values returned by getGateways.

See also

Parameters

businessStatus

Limit search to specific business status - valid value is "Normal", "FinancialLocked".

enableIpsec

Indicates whether the IPsec-VPN feature is enabled.

ids

IDs of the VPN.

includeReservationData

Include ineffective ordering data.

nameRegex

A regex string of VPN name.

outputFile

Save the result to the file.

status

Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".

vpcId

Use the VPC ID as the search key.

suspend fun getGateways(argument: suspend GetGatewaysPlainArgsBuilder.() -> Unit): GetGatewaysResult

Return

A collection of values returned by getGateways.

See also

Parameters

argument

Builder for com.pulumi.alicloud.vpn.kotlin.inputs.GetGatewaysPlainArgs.