Skip to content

CreateVpnConnectionRequest

Source code in docs_src/capo_ec2/types/create_vpn_connection_request.py
class CreateVpnConnectionRequest(TypedDict, closed=True):
    customer_gateway_id: NotRequired[
        "capo_ec2.types.customer_gateway_id.CustomerGatewayId"
    ]
    """<p>The ID of the customer gateway.</p>"""
    type: NotRequired["capo_ec2.types.string.String"]
    """<p>The type of VPN connection (<code>ipsec.1</code>).</p>"""
    vpn_gateway_id: NotRequired["capo_ec2.types.vpn_gateway_id.VpnGatewayId"]
    """<p>The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.</p>"""
    transit_gateway_id: NotRequired[
        "capo_ec2.types.transit_gateway_id.TransitGatewayId"
    ]
    """<p>The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.</p>"""
    vpn_concentrator_id: NotRequired[
        "capo_ec2.types.vpn_concentrator_id.VpnConcentratorId"
    ]
    """<p>The ID of the VPN concentrator to associate with the VPN connection.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to apply to the VPN connection.</p>"""
    pre_shared_key_storage: NotRequired["capo_ec2.types.string.String"]
    """<p>Specifies the storage mode for the pre-shared key (PSK). Valid values are <code>Standard</code>" (stored in the Site-to-Site VPN service) or <code>SecretsManager</code> (stored in Amazon Web Services Secrets Manager).</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    options: NotRequired[
        "capo_ec2.types.vpn_connection_options_specification.VpnConnectionOptionsSpecification"
    ]
    """<p>The options for the VPN connection.</p>"""

customer_gateway_id instance-attribute

customer_gateway_id: NotRequired[CustomerGatewayId]

The ID of the customer gateway.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

options instance-attribute

options: NotRequired[VpnConnectionOptionsSpecification]

The options for the VPN connection.

pre_shared_key_storage instance-attribute

pre_shared_key_storage: NotRequired[String]

Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard" (stored in the Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

The tags to apply to the VPN connection.

transit_gateway_id instance-attribute

transit_gateway_id: NotRequired[TransitGatewayId]

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

type instance-attribute

type: NotRequired[String]

The type of VPN connection (ipsec.1).

vpn_concentrator_id instance-attribute

vpn_concentrator_id: NotRequired[VpnConcentratorId]

The ID of the VPN concentrator to associate with the VPN connection.

vpn_gateway_id instance-attribute

vpn_gateway_id: NotRequired[VpnGatewayId]

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.