We recommend new projects start with resources from the AWS provider.
aws-native.ec2.VpnGateway
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. For more information, see in the User Guide.
Create VpnGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpnGateway(name: string, args: VpnGatewayArgs, opts?: CustomResourceOptions);
@overload
def VpnGateway(resource_name: str,
args: VpnGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpnGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
type: Optional[str] = None,
amazon_side_asn: Optional[int] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewVpnGateway(ctx *Context, name string, args VpnGatewayArgs, opts ...ResourceOption) (*VpnGateway, error)
public VpnGateway(string name, VpnGatewayArgs args, CustomResourceOptions? opts = null)
public VpnGateway(String name, VpnGatewayArgs args)
public VpnGateway(String name, VpnGatewayArgs args, CustomResourceOptions options)
type: aws-native:ec2:VpnGateway
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 VpnGatewayArgs
- 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 VpnGatewayArgs
- 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 VpnGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpnGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpnGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VpnGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VpnGateway resource accepts the following input properties:
- Type string
- The type of VPN connection the virtual private gateway supports.
- Amazon
Side intAsn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- List<Pulumi.
Aws Native. Inputs. Tag> - Any tags assigned to the virtual private gateway.
- Type string
- The type of VPN connection the virtual private gateway supports.
- Amazon
Side intAsn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- Tag
Args - Any tags assigned to the virtual private gateway.
- type String
- The type of VPN connection the virtual private gateway supports.
- amazon
Side IntegerAsn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- List<Tag>
- Any tags assigned to the virtual private gateway.
- type string
- The type of VPN connection the virtual private gateway supports.
- amazon
Side numberAsn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- Tag[]
- Any tags assigned to the virtual private gateway.
- type str
- The type of VPN connection the virtual private gateway supports.
- amazon_
side_ intasn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- Sequence[Tag
Args] - Any tags assigned to the virtual private gateway.
- type String
- The type of VPN connection the virtual private gateway supports.
- amazon
Side NumberAsn - The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- List<Property Map>
- Any tags assigned to the virtual private gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpnGateway resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Vpn
Gateway stringId - The ID of the VPN gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Vpn
Gateway stringId - The ID of the VPN gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- vpn
Gateway StringId - The ID of the VPN gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- vpn
Gateway stringId - The ID of the VPN gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- vpn_
gateway_ strid - The ID of the VPN gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- vpn
Gateway StringId - The ID of the VPN gateway.
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.