Skip to content

EC2  >  Operations  >  get_vpn_connection_device_sample_configuration

get_vpn_connection_device_sample_configuration

Operation

get_vpn_connection_device_sample_configuration async

get_vpn_connection_device_sample_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpnConnectionDeviceSampleConfigurationInputDict]) -> GetVpnConnectionDeviceSampleConfigurationOutput

Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetVpnConnectionDeviceSampleConfigurationOutput

An instance of GetVpnConnectionDeviceSampleConfigurationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

GetVpnConnectionDeviceSampleConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetVpnConnectionDeviceSampleConfigurationInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

internet_key_exchange_version class-attribute instance-attribute
internet_key_exchange_version: str | None = ...

The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.

sample_type class-attribute instance-attribute
sample_type: str | None = ...

The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1).

vpn_connection_device_type_id class-attribute instance-attribute
vpn_connection_device_type_id: str | None = ...

Device identifier provided by the GetVpnConnectionDeviceTypes API.

vpn_connection_id class-attribute instance-attribute
vpn_connection_id: str | None = ...

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

Dictionaries

GetVpnConnectionDeviceSampleConfigurationInputDict

Bases: TypedDict

Dictionary form of GetVpnConnectionDeviceSampleConfigurationInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

internet_key_exchange_version instance-attribute
internet_key_exchange_version: str | None

The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.

sample_type instance-attribute
sample_type: str | None

The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1).

vpn_connection_device_type_id instance-attribute
vpn_connection_device_type_id: Required[str]

Device identifier provided by the GetVpnConnectionDeviceTypes API.

vpn_connection_id instance-attribute
vpn_connection_id: Required[str]

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

Output

GetVpnConnectionDeviceSampleConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetVpnConnectionDeviceSampleConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

vpn_connection_device_sample_configuration class-attribute instance-attribute
vpn_connection_device_sample_configuration: str | None = ...

Sample configuration file for the specified customer gateway device.