aws_sdk_ec2/client/

get_vpn_connection_device_sample_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetVpnConnectionDeviceSampleConfiguration`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`vpn_connection_id(impl Into<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::vpn_connection_id) / [`set_vpn_connection_id(Option<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::set_vpn_connection_id):<br>required: **true**<br><p>The <code>VpnConnectionId</code> specifies the Site-to-Site VPN connection used for the sample configuration.</p><br>
    ///   - [`vpn_connection_device_type_id(impl Into<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::vpn_connection_device_type_id) / [`set_vpn_connection_device_type_id(Option<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::set_vpn_connection_device_type_id):<br>required: **true**<br><p>Device identifier provided by the <code>GetVpnConnectionDeviceTypes</code> API.</p><br>
    ///   - [`internet_key_exchange_version(impl Into<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::internet_key_exchange_version) / [`set_internet_key_exchange_version(Option<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::set_internet_key_exchange_version):<br>required: **false**<br><p>The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: <code>ikev1</code> or <code>ikev2</code>.</p><br>
    ///   - [`sample_type(impl Into<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::sample_type) / [`set_sample_type(Option<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::set_sample_type):<br>required: **false**<br><p>The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1).</p><br>
    ///   - [`dry_run(bool)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
    /// - On success, responds with [`GetVpnConnectionDeviceSampleConfigurationOutput`](crate::operation::get_vpn_connection_device_sample_configuration::GetVpnConnectionDeviceSampleConfigurationOutput) with field(s):
    ///   - [`vpn_connection_device_sample_configuration(Option<String>)`](crate::operation::get_vpn_connection_device_sample_configuration::GetVpnConnectionDeviceSampleConfigurationOutput::vpn_connection_device_sample_configuration): <p>Sample configuration file for the specified customer gateway device.</p>
    /// - On failure, responds with [`SdkError<GetVpnConnectionDeviceSampleConfigurationError>`](crate::operation::get_vpn_connection_device_sample_configuration::GetVpnConnectionDeviceSampleConfigurationError)
    pub fn get_vpn_connection_device_sample_configuration(
        &self,
    ) -> crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder {
        crate::operation::get_vpn_connection_device_sample_configuration::builders::GetVpnConnectionDeviceSampleConfigurationFluentBuilder::new(
            self.handle.clone(),
        )
    }
}