AWS Native is in preview. AWS Classic is fully supported.
aws-native.ec2.CustomerGateway
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const customerGatewayResource = new aws_native.ec2.CustomerGateway("customerGatewayResource", {
ipAddress: "string",
type: "string",
bgpAsn: 0,
bgpAsnExtended: 0,
certificateArn: "string",
deviceName: "string",
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
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.
- Type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - Bgp
Asn int - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- Bgp
Asn doubleExtended - Certificate
Arn string - 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.
- Type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - Bgp
Asn int - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- Bgp
Asn float64Extended - Certificate
Arn string - 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.
- type String
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn Integer - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- bgp
Asn DoubleExtended - certificate
Arn String - 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.
- type string
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn number - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- bgp
Asn numberExtended - certificate
Arn string - 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.
- type str
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp_
asn int - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- bgp_
asn_ floatextended - certificate_
arn str - 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.
- type String
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - bgp
Asn Number - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000
- bgp
Asn NumberExtended - certificate
Arn String - 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 - Id string
- The provider-assigned unique ID for this managed resource.
- Customer
Gateway stringId - Id string
- The provider-assigned unique ID for this managed resource.
- customer
Gateway StringId - id String
- The provider-assigned unique ID for this managed resource.
- customer
Gateway stringId - id string
- The provider-assigned unique ID for this managed resource.
- customer_
gateway_ strid - id str
- The provider-assigned unique ID for this managed resource.
- customer
Gateway StringId - 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
AWS Native is in preview. AWS Classic is fully supported.