#[non_exhaustive]pub struct ActivateGatewayInputBuilder { /* private fields */ }
Expand description
A builder for ActivateGatewayInput
.
Implementations§
Source§impl ActivateGatewayInputBuilder
impl ActivateGatewayInputBuilder
Sourcepub fn activation_key(self, input: impl Into<String>) -> Self
pub fn activation_key(self, input: impl Into<String>) -> Self
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey
. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway
API call determine the actual configuration of your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide.
This field is required.Sourcepub fn set_activation_key(self, input: Option<String>) -> Self
pub fn set_activation_key(self, input: Option<String>) -> Self
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey
. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway
API call determine the actual configuration of your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide.
Sourcepub fn get_activation_key(&self) -> &Option<String>
pub fn get_activation_key(&self) -> &Option<String>
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey
. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway
API call determine the actual configuration of your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide.
Sourcepub fn gateway_name(self, input: impl Into<String>) -> Self
pub fn gateway_name(self, input: impl Into<String>) -> Self
The name you configured for your gateway.
This field is required.Sourcepub fn set_gateway_name(self, input: Option<String>) -> Self
pub fn set_gateway_name(self, input: Option<String>) -> Self
The name you configured for your gateway.
Sourcepub fn get_gateway_name(&self) -> &Option<String>
pub fn get_gateway_name(&self) -> &Option<String>
The name you configured for your gateway.
Sourcepub fn gateway_timezone(self, input: impl Into<String>) -> Self
pub fn gateway_timezone(self, input: impl Into<String>) -> Self
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
This field is required.Sourcepub fn set_gateway_timezone(self, input: Option<String>) -> Self
pub fn set_gateway_timezone(self, input: Option<String>) -> Self
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
Sourcepub fn get_gateway_timezone(&self) -> &Option<String>
pub fn get_gateway_timezone(&self) -> &Option<String>
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
Sourcepub fn gateway_region(self, input: impl Into<String>) -> Self
pub fn gateway_region(self, input: impl Into<String>) -> Self
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host
header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
This field is required.Sourcepub fn set_gateway_region(self, input: Option<String>) -> Self
pub fn set_gateway_region(self, input: Option<String>) -> Self
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host
header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Sourcepub fn get_gateway_region(&self) -> &Option<String>
pub fn get_gateway_region(&self) -> &Option<String>
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host
header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Sourcepub fn gateway_type(self, input: impl Into<String>) -> Self
pub fn gateway_type(self, input: impl Into<String>) -> Self
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED
.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
Valid Values: STORED
| CACHED
| VTL
| FILE_S3
| FILE_FSX_SMB
Sourcepub fn set_gateway_type(self, input: Option<String>) -> Self
pub fn set_gateway_type(self, input: Option<String>) -> Self
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED
.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
Valid Values: STORED
| CACHED
| VTL
| FILE_S3
| FILE_FSX_SMB
Sourcepub fn get_gateway_type(&self) -> &Option<String>
pub fn get_gateway_type(&self) -> &Option<String>
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED
.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
Valid Values: STORED
| CACHED
| VTL
| FILE_S3
| FILE_FSX_SMB
Sourcepub fn tape_drive_type(self, input: impl Into<String>) -> Self
pub fn tape_drive_type(self, input: impl Into<String>) -> Self
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
Sourcepub fn set_tape_drive_type(self, input: Option<String>) -> Self
pub fn set_tape_drive_type(self, input: Option<String>) -> Self
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
Sourcepub fn get_tape_drive_type(&self) -> &Option<String>
pub fn get_tape_drive_type(&self) -> &Option<String>
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
Sourcepub fn medium_changer_type(self, input: impl Into<String>) -> Self
pub fn medium_changer_type(self, input: impl Into<String>) -> Self
The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: STK-L700
| AWS-Gateway-VTL
| IBM-03584L32-0402
Sourcepub fn set_medium_changer_type(self, input: Option<String>) -> Self
pub fn set_medium_changer_type(self, input: Option<String>) -> Self
The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: STK-L700
| AWS-Gateway-VTL
| IBM-03584L32-0402
Sourcepub fn get_medium_changer_type(&self) -> &Option<String>
pub fn get_medium_changer_type(&self) -> &Option<String>
The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: STK-L700
| AWS-Gateway-VTL
| IBM-03584L32-0402
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
Sourcepub fn build(self) -> Result<ActivateGatewayInput, BuildError>
pub fn build(self) -> Result<ActivateGatewayInput, BuildError>
Consumes the builder and constructs a ActivateGatewayInput
.
Source§impl ActivateGatewayInputBuilder
impl ActivateGatewayInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ActivateGatewayOutput, SdkError<ActivateGatewayError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ActivateGatewayOutput, SdkError<ActivateGatewayError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ActivateGatewayInputBuilder
impl Clone for ActivateGatewayInputBuilder
Source§fn clone(&self) -> ActivateGatewayInputBuilder
fn clone(&self) -> ActivateGatewayInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ActivateGatewayInputBuilder
impl Debug for ActivateGatewayInputBuilder
Source§impl Default for ActivateGatewayInputBuilder
impl Default for ActivateGatewayInputBuilder
Source§fn default() -> ActivateGatewayInputBuilder
fn default() -> ActivateGatewayInputBuilder
impl StructuralPartialEq for ActivateGatewayInputBuilder
Auto Trait Implementations§
impl Freeze for ActivateGatewayInputBuilder
impl RefUnwindSafe for ActivateGatewayInputBuilder
impl Send for ActivateGatewayInputBuilder
impl Sync for ActivateGatewayInputBuilder
impl Unpin for ActivateGatewayInputBuilder
impl UnwindSafe for ActivateGatewayInputBuilder
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);