#[non_exhaustive]pub struct KeySigningKeyBuilder { /* private fields */ }Expand description
A builder for KeySigningKey.
Implementations§
Source§impl KeySigningKeyBuilder
impl KeySigningKeyBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.
Sourcepub fn kms_arn(self, input: impl Into<String>) -> Self
pub fn kms_arn(self, input: impl Into<String>) -> Self
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
The key policy must give permission for the following actions:
-
DescribeKey
-
GetPublicKey
-
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
-
"Service": "dnssec-route53.amazonaws.com"
-
For more information about working with the customer managed key in KMS, see Key Management Service concepts.
Sourcepub fn set_kms_arn(self, input: Option<String>) -> Self
pub fn set_kms_arn(self, input: Option<String>) -> Self
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
The key policy must give permission for the following actions:
-
DescribeKey
-
GetPublicKey
-
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
-
"Service": "dnssec-route53.amazonaws.com"
-
For more information about working with the customer managed key in KMS, see Key Management Service concepts.
Sourcepub fn get_kms_arn(&self) -> &Option<String>
pub fn get_kms_arn(&self) -> &Option<String>
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
The key policy must give permission for the following actions:
-
DescribeKey
-
GetPublicKey
-
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
-
"Service": "dnssec-route53.amazonaws.com"
-
For more information about working with the customer managed key in KMS, see Key Management Service concepts.
Sourcepub fn flag(self, input: i32) -> Self
pub fn flag(self, input: i32) -> Self
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
Sourcepub fn set_flag(self, input: Option<i32>) -> Self
pub fn set_flag(self, input: Option<i32>) -> Self
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
Sourcepub fn get_flag(&self) -> &Option<i32>
pub fn get_flag(&self) -> &Option<i32>
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
Sourcepub fn signing_algorithm_mnemonic(self, input: impl Into<String>) -> Self
pub fn signing_algorithm_mnemonic(self, input: impl Into<String>) -> Self
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn set_signing_algorithm_mnemonic(self, input: Option<String>) -> Self
pub fn set_signing_algorithm_mnemonic(self, input: Option<String>) -> Self
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn get_signing_algorithm_mnemonic(&self) -> &Option<String>
pub fn get_signing_algorithm_mnemonic(&self) -> &Option<String>
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn signing_algorithm_type(self, input: i32) -> Self
pub fn signing_algorithm_type(self, input: i32) -> Self
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn set_signing_algorithm_type(self, input: Option<i32>) -> Self
pub fn set_signing_algorithm_type(self, input: Option<i32>) -> Self
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn get_signing_algorithm_type(&self) -> &Option<i32>
pub fn get_signing_algorithm_type(&self) -> &Option<i32>
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
Sourcepub fn digest_algorithm_mnemonic(self, input: impl Into<String>) -> Self
pub fn digest_algorithm_mnemonic(self, input: impl Into<String>) -> Self
A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn set_digest_algorithm_mnemonic(self, input: Option<String>) -> Self
pub fn set_digest_algorithm_mnemonic(self, input: Option<String>) -> Self
A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn get_digest_algorithm_mnemonic(&self) -> &Option<String>
pub fn get_digest_algorithm_mnemonic(&self) -> &Option<String>
A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn digest_algorithm_type(self, input: i32) -> Self
pub fn digest_algorithm_type(self, input: i32) -> Self
An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn set_digest_algorithm_type(self, input: Option<i32>) -> Self
pub fn set_digest_algorithm_type(self, input: Option<i32>) -> Self
An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn get_digest_algorithm_type(&self) -> &Option<i32>
pub fn get_digest_algorithm_type(&self) -> &Option<i32>
An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
Sourcepub fn key_tag(self, input: i32) -> Self
pub fn key_tag(self, input: i32) -> Self
An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.
Sourcepub fn set_key_tag(self, input: Option<i32>) -> Self
pub fn set_key_tag(self, input: Option<i32>) -> Self
An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.
Sourcepub fn get_key_tag(&self) -> &Option<i32>
pub fn get_key_tag(&self) -> &Option<i32>
An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.
Sourcepub fn digest_value(self, input: impl Into<String>) -> Self
pub fn digest_value(self, input: impl Into<String>) -> Self
A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
Sourcepub fn set_digest_value(self, input: Option<String>) -> Self
pub fn set_digest_value(self, input: Option<String>) -> Self
A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
Sourcepub fn get_digest_value(&self) -> &Option<String>
pub fn get_digest_value(&self) -> &Option<String>
A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
Sourcepub fn public_key(self, input: impl Into<String>) -> Self
pub fn public_key(self, input: impl Into<String>) -> Self
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
Sourcepub fn set_public_key(self, input: Option<String>) -> Self
pub fn set_public_key(self, input: Option<String>) -> Self
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
Sourcepub fn get_public_key(&self) -> &Option<String>
pub fn get_public_key(&self) -> &Option<String>
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
Sourcepub fn ds_record(self, input: impl Into<String>) -> Self
pub fn ds_record(self, input: impl Into<String>) -> Self
A string that represents a delegation signer (DS) record.
Sourcepub fn set_ds_record(self, input: Option<String>) -> Self
pub fn set_ds_record(self, input: Option<String>) -> Self
A string that represents a delegation signer (DS) record.
Sourcepub fn get_ds_record(&self) -> &Option<String>
pub fn get_ds_record(&self) -> &Option<String>
A string that represents a delegation signer (DS) record.
Sourcepub fn dnskey_record(self, input: impl Into<String>) -> Self
pub fn dnskey_record(self, input: impl Into<String>) -> Self
A string that represents a DNSKEY record.
Sourcepub fn set_dnskey_record(self, input: Option<String>) -> Self
pub fn set_dnskey_record(self, input: Option<String>) -> Self
A string that represents a DNSKEY record.
Sourcepub fn get_dnskey_record(&self) -> &Option<String>
pub fn get_dnskey_record(&self) -> &Option<String>
A string that represents a DNSKEY record.
Sourcepub fn status(self, input: impl Into<String>) -> Self
pub fn status(self, input: impl Into<String>) -> Self
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
- ACTIVE
-
The KSK is being used for signing.
- INACTIVE
-
The KSK is not being used for signing.
- DELETING
-
The KSK is in the process of being deleted.
- ACTION_NEEDED
-
There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.
- INTERNAL_FAILURE
-
There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
- ACTIVE
-
The KSK is being used for signing.
- INACTIVE
-
The KSK is not being used for signing.
- DELETING
-
The KSK is in the process of being deleted.
- ACTION_NEEDED
-
There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.
- INTERNAL_FAILURE
-
There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
- ACTIVE
-
The KSK is being used for signing.
- INACTIVE
-
The KSK is not being used for signing.
- DELETING
-
The KSK is in the process of being deleted.
- ACTION_NEEDED
-
There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.
- INTERNAL_FAILURE
-
There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
Sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.
Sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.
Sourcepub fn created_date(self, input: DateTime) -> Self
pub fn created_date(self, input: DateTime) -> Self
The date when the key-signing key (KSK) was created.
Sourcepub fn set_created_date(self, input: Option<DateTime>) -> Self
pub fn set_created_date(self, input: Option<DateTime>) -> Self
The date when the key-signing key (KSK) was created.
Sourcepub fn get_created_date(&self) -> &Option<DateTime>
pub fn get_created_date(&self) -> &Option<DateTime>
The date when the key-signing key (KSK) was created.
Sourcepub fn last_modified_date(self, input: DateTime) -> Self
pub fn last_modified_date(self, input: DateTime) -> Self
The last time that the key-signing key (KSK) was changed.
Sourcepub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
The last time that the key-signing key (KSK) was changed.
Sourcepub fn get_last_modified_date(&self) -> &Option<DateTime>
pub fn get_last_modified_date(&self) -> &Option<DateTime>
The last time that the key-signing key (KSK) was changed.
Sourcepub fn build(self) -> KeySigningKey
pub fn build(self) -> KeySigningKey
Consumes the builder and constructs a KeySigningKey.
Trait Implementations§
Source§impl Clone for KeySigningKeyBuilder
impl Clone for KeySigningKeyBuilder
Source§fn clone(&self) -> KeySigningKeyBuilder
fn clone(&self) -> KeySigningKeyBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for KeySigningKeyBuilder
impl Debug for KeySigningKeyBuilder
Source§impl Default for KeySigningKeyBuilder
impl Default for KeySigningKeyBuilder
Source§fn default() -> KeySigningKeyBuilder
fn default() -> KeySigningKeyBuilder
Source§impl PartialEq for KeySigningKeyBuilder
impl PartialEq for KeySigningKeyBuilder
Source§fn eq(&self, other: &KeySigningKeyBuilder) -> bool
fn eq(&self, other: &KeySigningKeyBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for KeySigningKeyBuilder
Auto Trait Implementations§
impl Freeze for KeySigningKeyBuilder
impl RefUnwindSafe for KeySigningKeyBuilder
impl Send for KeySigningKeyBuilder
impl Sync for KeySigningKeyBuilder
impl Unpin for KeySigningKeyBuilder
impl UnsafeUnpin for KeySigningKeyBuilder
impl UnwindSafe for KeySigningKeyBuilder
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>
renamed to 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);