@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
102 lines (101 loc) • 5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Specifies a customer gateway.
*/
export declare class CustomerGateway extends pulumi.CustomResource {
/**
* Get an existing CustomerGateway 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CustomerGateway;
/**
* Returns true if the given object is an instance of CustomerGateway. 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 CustomerGateway;
/**
* For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.
* Default: 65000
* Valid values: ``1`` to ``2,147,483,647``
*/
readonly bgpAsn: pulumi.Output<number | undefined>;
/**
* For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.
* Valid values: ``2,147,483,648`` to ``4,294,967,295``
*/
readonly bgpAsnExtended: pulumi.Output<number | undefined>;
/**
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*/
readonly certificateArn: pulumi.Output<string | undefined>;
/**
* The ID of the customer gateway.
*/
readonly customerGatewayId: pulumi.Output<string>;
/**
* The name of customer gateway device.
*/
readonly deviceName: pulumi.Output<string | undefined>;
/**
* IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address.
*/
readonly ipAddress: pulumi.Output<string>;
/**
* One or more tags for the customer gateway.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The type of VPN connection that this customer gateway supports (``ipsec.1``).
*/
readonly type: pulumi.Output<string>;
/**
* Create a CustomerGateway 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: CustomerGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CustomerGateway resource.
*/
export interface CustomerGatewayArgs {
/**
* For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.
* Default: 65000
* Valid values: ``1`` to ``2,147,483,647``
*/
bgpAsn?: pulumi.Input<number>;
/**
* For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``.
* Valid values: ``2,147,483,648`` to ``4,294,967,295``
*/
bgpAsnExtended?: pulumi.Input<number>;
/**
* The Amazon Resource Name (ARN) for the customer gateway certificate.
*/
certificateArn?: pulumi.Input<string>;
/**
* The name of customer gateway device.
*/
deviceName?: pulumi.Input<string>;
/**
* IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address.
*/
ipAddress: pulumi.Input<string>;
/**
* One or more tags for the customer gateway.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The type of VPN connection that this customer gateway supports (``ipsec.1``).
*/
type: pulumi.Input<string>;
}