#[non_exhaustive]pub struct ImportKeyMaterialInputBuilder { /* private fields */ }
Expand description
A builder for ImportKeyMaterialInput
.
Implementations§
Source§impl ImportKeyMaterialInputBuilder
impl ImportKeyMaterialInputBuilder
Sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport
request. The Origin
of the KMS key must be EXTERNAL
and its KeyState
must be PendingImport
.
The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
Sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport
request. The Origin
of the KMS key must be EXTERNAL
and its KeyState
must be PendingImport
.
The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
Sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &Option<String>
The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport
request. The Origin
of the KMS key must be EXTERNAL
and its KeyState
must be PendingImport
.
The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
Sourcepub fn import_token(self, input: Blob) -> Self
pub fn import_token(self, input: Blob) -> Self
The import token that you received in the response to a previous GetParametersForImport
request. It must be from the same response that contained the public key that you used to encrypt the key material.
Sourcepub fn set_import_token(self, input: Option<Blob>) -> Self
pub fn set_import_token(self, input: Option<Blob>) -> Self
The import token that you received in the response to a previous GetParametersForImport
request. It must be from the same response that contained the public key that you used to encrypt the key material.
Sourcepub fn get_import_token(&self) -> &Option<Blob>
pub fn get_import_token(&self) -> &Option<Blob>
The import token that you received in the response to a previous GetParametersForImport
request. It must be from the same response that contained the public key that you used to encrypt the key material.
Sourcepub fn encrypted_key_material(self, input: Blob) -> Self
pub fn encrypted_key_material(self, input: Blob) -> Self
The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport
returned, using the wrapping algorithm that you specified in the same GetParametersForImport
request.
Sourcepub fn set_encrypted_key_material(self, input: Option<Blob>) -> Self
pub fn set_encrypted_key_material(self, input: Option<Blob>) -> Self
The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport
returned, using the wrapping algorithm that you specified in the same GetParametersForImport
request.
Sourcepub fn get_encrypted_key_material(&self) -> &Option<Blob>
pub fn get_encrypted_key_material(&self) -> &Option<Blob>
The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport
returned, using the wrapping algorithm that you specified in the same GetParametersForImport
request.
Sourcepub fn valid_to(self, input: DateTime) -> Self
pub fn valid_to(self, input: DateTime) -> Self
The date and time when the imported key material expires. This parameter is required when the value of the ExpirationModel
parameter is KEY_MATERIAL_EXPIRES
. Otherwise it is not valid.
The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial
) and reimport the key material.
Sourcepub fn set_valid_to(self, input: Option<DateTime>) -> Self
pub fn set_valid_to(self, input: Option<DateTime>) -> Self
The date and time when the imported key material expires. This parameter is required when the value of the ExpirationModel
parameter is KEY_MATERIAL_EXPIRES
. Otherwise it is not valid.
The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial
) and reimport the key material.
Sourcepub fn get_valid_to(&self) -> &Option<DateTime>
pub fn get_valid_to(&self) -> &Option<DateTime>
The date and time when the imported key material expires. This parameter is required when the value of the ExpirationModel
parameter is KEY_MATERIAL_EXPIRES
. Otherwise it is not valid.
The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial
) and reimport the key material.
Sourcepub fn expiration_model(self, input: ExpirationModelType) -> Self
pub fn expiration_model(self, input: ExpirationModelType) -> Self
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must specify a value for the ValidTo
parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.
Sourcepub fn set_expiration_model(self, input: Option<ExpirationModelType>) -> Self
pub fn set_expiration_model(self, input: Option<ExpirationModelType>) -> Self
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must specify a value for the ValidTo
parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.
Sourcepub fn get_expiration_model(&self) -> &Option<ExpirationModelType>
pub fn get_expiration_model(&self) -> &Option<ExpirationModelType>
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must specify a value for the ValidTo
parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.
Sourcepub fn build(self) -> Result<ImportKeyMaterialInput, BuildError>
pub fn build(self) -> Result<ImportKeyMaterialInput, BuildError>
Consumes the builder and constructs a ImportKeyMaterialInput
.
Source§impl ImportKeyMaterialInputBuilder
impl ImportKeyMaterialInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ImportKeyMaterialOutput, SdkError<ImportKeyMaterialError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ImportKeyMaterialOutput, SdkError<ImportKeyMaterialError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ImportKeyMaterialInputBuilder
impl Clone for ImportKeyMaterialInputBuilder
Source§fn clone(&self) -> ImportKeyMaterialInputBuilder
fn clone(&self) -> ImportKeyMaterialInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ImportKeyMaterialInputBuilder
impl Default for ImportKeyMaterialInputBuilder
Source§fn default() -> ImportKeyMaterialInputBuilder
fn default() -> ImportKeyMaterialInputBuilder
Source§impl PartialEq for ImportKeyMaterialInputBuilder
impl PartialEq for ImportKeyMaterialInputBuilder
Source§fn eq(&self, other: &ImportKeyMaterialInputBuilder) -> bool
fn eq(&self, other: &ImportKeyMaterialInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ImportKeyMaterialInputBuilder
Auto Trait Implementations§
impl Freeze for ImportKeyMaterialInputBuilder
impl RefUnwindSafe for ImportKeyMaterialInputBuilder
impl Send for ImportKeyMaterialInputBuilder
impl Sync for ImportKeyMaterialInputBuilder
impl Unpin for ImportKeyMaterialInputBuilder
impl UnwindSafe for ImportKeyMaterialInputBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);