We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.2 published on Friday, Oct 4, 2024 by Pulumi
aws-native.ec2.CustomerGateway
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.2 published on Friday, Oct 4, 2024 by Pulumi
Specifies a customer gateway.
Create CustomerGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomerGateway(name: string, args: CustomerGatewayArgs, opts?: CustomResourceOptions);
@overload
def CustomerGateway(resource_name: str,
args: CustomerGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomerGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
ip_address: Optional[str] = None,
type: Optional[str] = None,
bgp_asn: Optional[int] = None,
bgp_asn_extended: Optional[float] = None,
certificate_arn: Optional[str] = None,
device_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewCustomerGateway(ctx *Context, name string, args CustomerGatewayArgs, opts ...ResourceOption) (*CustomerGateway, error)
public CustomerGateway(string name, CustomerGatewayArgs args, CustomResourceOptions? opts = null)
public CustomerGateway(String name, CustomerGatewayArgs args)
public CustomerGateway(String name, CustomerGatewayArgs args, CustomResourceOptions options)
type: aws-native:ec2:CustomerGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CustomerGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CustomerGatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CustomerGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomerGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomerGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CustomerGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CustomerGateway resource accepts the following input properties:
- Ip
Address 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 toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - Type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - Bgp
Asn int - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- Bgp
Asn doubleExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- Certificate
Arn string - The Amazon Resource Name (ARN) for the customer gateway certificate.
- Device
Name string - The name of customer gateway device.
- List<Pulumi.
Aws Native. Inputs. Tag> - One or more tags for the customer gateway.
- Ip
Address 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 toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - Type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - Bgp
Asn int - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- Bgp
Asn float64Extended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- Certificate
Arn string - The Amazon Resource Name (ARN) for the customer gateway certificate.
- Device
Name string - The name of customer gateway device.
- Tag
Args - One or more tags for the customer gateway.
- ip
Address 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 toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - type String
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn Integer - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- bgp
Asn DoubleExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- certificate
Arn String - The Amazon Resource Name (ARN) for the customer gateway certificate.
- device
Name String - The name of customer gateway device.
- List<Tag>
- One or more tags for the customer gateway.
- ip
Address 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 toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn number - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- bgp
Asn numberExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- certificate
Arn string - The Amazon Resource Name (ARN) for the customer gateway certificate.
- device
Name string - The name of customer gateway device.
- Tag[]
- One or more tags for the customer gateway.
- ip_
address str - IPv4 address for the customer gateway device's outside interface. The address must be static. If
OutsideIpAddressType
in your VPN connection options is set toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - type str
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp_
asn int - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- bgp_
asn_ floatextended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- certificate_
arn str - The Amazon Resource Name (ARN) for the customer gateway certificate.
- device_
name str - The name of customer gateway device.
- Sequence[Tag
Args] - One or more tags for the customer gateway.
- ip
Address 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 toPrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. IfOutsideIpAddressType
is set toPublicIpv4
, you can use a public IPv4 address. - type String
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn Number - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Default: 65000 Valid values:1
to2,147,483,647
- bgp
Asn NumberExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either
BgpAsn
orBgpAsnExtended
when creating the customer gateway. If the ASN is larger than2,147,483,647
, you must useBgpAsnExtended
. Valid values:2,147,483,648
to4,294,967,295
- certificate
Arn String - The Amazon Resource Name (ARN) for the customer gateway certificate.
- device
Name String - The name of customer gateway device.
- List<Property Map>
- One or more tags for the customer gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomerGateway resource produces the following output properties:
- Customer
Gateway stringId - The ID of the customer gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Customer
Gateway stringId - The ID of the customer gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- customer
Gateway StringId - The ID of the customer gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- customer
Gateway stringId - The ID of the customer gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- customer_
gateway_ strid - The ID of the customer gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- customer
Gateway StringId - The ID of the customer gateway.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.2 published on Friday, Oct 4, 2024 by Pulumi