pub struct CreateHsmFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateHsm
.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create with the CreateHsm
operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm
operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.
It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm
operation. The HSM is ready to be initialized when the status changes to RUNNING
.
Implementationsยง
Sourceยงimpl CreateHsmFluentBuilder
impl CreateHsmFluentBuilder
Sourcepub fn as_input(&self) -> &CreateHsmInputBuilder
pub fn as_input(&self) -> &CreateHsmInputBuilder
Access the CreateHsm as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateHsmOutput, SdkError<CreateHsmError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateHsmOutput, SdkError<CreateHsmError, 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<CreateHsmOutput, CreateHsmError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateHsmOutput, CreateHsmError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn subnet_id(self, input: impl Into<String>) -> Self
pub fn subnet_id(self, input: impl Into<String>) -> Self
The identifier of the subnet in your VPC in which to place the HSM.
Sourcepub fn set_subnet_id(self, input: Option<String>) -> Self
pub fn set_subnet_id(self, input: Option<String>) -> Self
The identifier of the subnet in your VPC in which to place the HSM.
Sourcepub fn get_subnet_id(&self) -> &Option<String>
pub fn get_subnet_id(&self) -> &Option<String>
The identifier of the subnet in your VPC in which to place the HSM.
Sourcepub fn ssh_key(self, input: impl Into<String>) -> Self
pub fn ssh_key(self, input: impl Into<String>) -> Self
The SSH public key to install on the HSM.
Sourcepub fn set_ssh_key(self, input: Option<String>) -> Self
pub fn set_ssh_key(self, input: Option<String>) -> Self
The SSH public key to install on the HSM.
Sourcepub fn get_ssh_key(&self) -> &Option<String>
pub fn get_ssh_key(&self) -> &Option<String>
The SSH public key to install on the HSM.
Sourcepub fn eni_ip(self, input: impl Into<String>) -> Self
pub fn eni_ip(self, input: impl Into<String>) -> Self
The IP address to assign to the HSM's ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
Sourcepub fn set_eni_ip(self, input: Option<String>) -> Self
pub fn set_eni_ip(self, input: Option<String>) -> Self
The IP address to assign to the HSM's ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
Sourcepub fn get_eni_ip(&self) -> &Option<String>
pub fn get_eni_ip(&self) -> &Option<String>
The IP address to assign to the HSM's ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
Sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
Sourcepub fn set_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_iam_role_arn(self, input: Option<String>) -> Self
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
Sourcepub fn get_iam_role_arn(&self) -> &Option<String>
pub fn get_iam_role_arn(&self) -> &Option<String>
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
Sourcepub fn external_id(self, input: impl Into<String>) -> Self
pub fn external_id(self, input: impl Into<String>) -> Self
The external ID from IamRoleArn
, if present.
Sourcepub fn set_external_id(self, input: Option<String>) -> Self
pub fn set_external_id(self, input: Option<String>) -> Self
The external ID from IamRoleArn
, if present.
Sourcepub fn get_external_id(&self) -> &Option<String>
pub fn get_external_id(&self) -> &Option<String>
The external ID from IamRoleArn
, if present.
Sourcepub fn subscription_type(self, input: SubscriptionType) -> Self
pub fn subscription_type(self, input: SubscriptionType) -> Self
Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
Sourcepub fn set_subscription_type(self, input: Option<SubscriptionType>) -> Self
pub fn set_subscription_type(self, input: Option<SubscriptionType>) -> Self
Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
Sourcepub fn get_subscription_type(&self) -> &Option<SubscriptionType>
pub fn get_subscription_type(&self) -> &Option<SubscriptionType>
Specifies the type of subscription for the HSM.
-
PRODUCTION - The HSM is being used in a production environment.
-
TRIAL - The HSM is being used in a product trial.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
Sourcepub fn syslog_ip(self, input: impl Into<String>) -> Self
pub fn syslog_ip(self, input: impl Into<String>) -> Self
The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
Sourcepub fn set_syslog_ip(self, input: Option<String>) -> Self
pub fn set_syslog_ip(self, input: Option<String>) -> Self
The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
Sourcepub fn get_syslog_ip(&self) -> &Option<String>
pub fn get_syslog_ip(&self) -> &Option<String>
The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
Trait Implementationsยง
Sourceยงimpl Clone for CreateHsmFluentBuilder
impl Clone for CreateHsmFluentBuilder
Sourceยงfn clone(&self) -> CreateHsmFluentBuilder
fn clone(&self) -> CreateHsmFluentBuilder
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 CreateHsmFluentBuilder
impl !RefUnwindSafe for CreateHsmFluentBuilder
impl Send for CreateHsmFluentBuilder
impl Sync for CreateHsmFluentBuilder
impl Unpin for CreateHsmFluentBuilder
impl !UnwindSafe for CreateHsmFluentBuilder
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);