pub struct CreateCustomerGatewayFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateCustomerGateway
.
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
Implementations§
Source§impl CreateCustomerGatewayFluentBuilder
impl CreateCustomerGatewayFluentBuilder
Sourcepub fn as_input(&self) -> &CreateCustomerGatewayInputBuilder
pub fn as_input(&self) -> &CreateCustomerGatewayInputBuilder
Access the CreateCustomerGateway as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateCustomerGatewayOutput, SdkError<CreateCustomerGatewayError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateCustomerGatewayOutput, SdkError<CreateCustomerGatewayError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateCustomerGatewayOutput, CreateCustomerGatewayError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateCustomerGatewayOutput, CreateCustomerGatewayError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn bgp_asn(self, input: i32) -> Self
pub fn bgp_asn(self, input: i32) -> Self
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Default: 65000
Valid values: 1
to 2,147,483,647
Sourcepub fn set_bgp_asn(self, input: Option<i32>) -> Self
pub fn set_bgp_asn(self, input: Option<i32>) -> Self
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Default: 65000
Valid values: 1
to 2,147,483,647
Sourcepub fn get_bgp_asn(&self) -> &Option<i32>
pub fn get_bgp_asn(&self) -> &Option<i32>
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Default: 65000
Valid values: 1
to 2,147,483,647
Sourcepub fn public_ip(self, input: impl Into<String>) -> Self
pub fn public_ip(self, input: impl Into<String>) -> Self
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
Sourcepub fn set_public_ip(self, input: Option<String>) -> Self
pub fn set_public_ip(self, input: Option<String>) -> Self
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
Sourcepub fn get_public_ip(&self) -> &Option<String>
pub fn get_public_ip(&self) -> &Option<String>
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
Sourcepub fn certificate_arn(self, input: impl Into<String>) -> Self
pub fn certificate_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the customer gateway certificate.
Sourcepub fn set_certificate_arn(self, input: Option<String>) -> Self
pub fn set_certificate_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the customer gateway certificate.
Sourcepub fn get_certificate_arn(&self) -> &Option<String>
pub fn get_certificate_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the customer gateway certificate.
Sourcepub fn type(self, input: GatewayType) -> Self
pub fn type(self, input: GatewayType) -> Self
The type of VPN connection that this customer gateway supports (ipsec.1
).
Sourcepub fn set_type(self, input: Option<GatewayType>) -> Self
pub fn set_type(self, input: Option<GatewayType>) -> Self
The type of VPN connection that this customer gateway supports (ipsec.1
).
Sourcepub fn get_type(&self) -> &Option<GatewayType>
pub fn get_type(&self) -> &Option<GatewayType>
The type of VPN connection that this customer gateway supports (ipsec.1
).
Sourcepub fn tag_specifications(self, input: TagSpecification) -> Self
pub fn tag_specifications(self, input: TagSpecification) -> Self
Appends an item to TagSpecifications
.
To override the contents of this collection use set_tag_specifications
.
The tags to apply to the customer gateway.
Sourcepub fn set_tag_specifications(
self,
input: Option<Vec<TagSpecification>>,
) -> Self
pub fn set_tag_specifications( self, input: Option<Vec<TagSpecification>>, ) -> Self
The tags to apply to the customer gateway.
Sourcepub fn get_tag_specifications(&self) -> &Option<Vec<TagSpecification>>
pub fn get_tag_specifications(&self) -> &Option<Vec<TagSpecification>>
The tags to apply to the customer gateway.
Sourcepub fn device_name(self, input: impl Into<String>) -> Self
pub fn device_name(self, input: impl Into<String>) -> Self
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
Sourcepub fn set_device_name(self, input: Option<String>) -> Self
pub fn set_device_name(self, input: Option<String>) -> Self
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
Sourcepub fn get_device_name(&self) -> &Option<String>
pub fn get_device_name(&self) -> &Option<String>
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
Sourcepub fn ip_address(self, input: impl Into<String>) -> Self
pub fn ip_address(self, input: impl Into<String>) -> Self
IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType
in your VPN connection options is set to PrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType
is set to PublicIpv4
, you can use a public IPv4 address.
Sourcepub fn set_ip_address(self, input: Option<String>) -> Self
pub fn set_ip_address(self, input: Option<String>) -> Self
IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType
in your VPN connection options is set to PrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType
is set to PublicIpv4
, you can use a public IPv4 address.
Sourcepub fn get_ip_address(&self) -> &Option<String>
pub fn get_ip_address(&self) -> &Option<String>
IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType
in your VPN connection options is set to PrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType
is set to PublicIpv4
, you can use a public IPv4 address.
Sourcepub fn bgp_asn_extended(self, input: i64) -> Self
pub fn bgp_asn_extended(self, input: i64) -> Self
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Valid values: 2,147,483,648
to 4,294,967,295
Sourcepub fn set_bgp_asn_extended(self, input: Option<i64>) -> Self
pub fn set_bgp_asn_extended(self, input: Option<i64>) -> Self
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Valid values: 2,147,483,648
to 4,294,967,295
Sourcepub fn get_bgp_asn_extended(&self) -> &Option<i64>
pub fn get_bgp_asn_extended(&self) -> &Option<i64>
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Valid values: 2,147,483,648
to 4,294,967,295
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
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
.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
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
.
Trait Implementations§
Source§impl Clone for CreateCustomerGatewayFluentBuilder
impl Clone for CreateCustomerGatewayFluentBuilder
Source§fn clone(&self) -> CreateCustomerGatewayFluentBuilder
fn clone(&self) -> CreateCustomerGatewayFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateCustomerGatewayFluentBuilder
impl !RefUnwindSafe for CreateCustomerGatewayFluentBuilder
impl Send for CreateCustomerGatewayFluentBuilder
impl Sync for CreateCustomerGatewayFluentBuilder
impl Unpin for CreateCustomerGatewayFluentBuilder
impl !UnwindSafe for CreateCustomerGatewayFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);