Struct aws_sdk_kms::operation::retire_grant::builders::RetireGrantInputBuilder

#[non_exhaustive]
pub struct RetireGrantInputBuilder { /* private fields */ }

A builder for RetireGrantInput.

Implementations

impl RetireGrantInputBuilder

pub fn grant_token(self, input: impl Into<String>) -> Self

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn set_grant_token(self, input: Option<String>) -> Self

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn get_grant_token(&self) -> &Option<String>

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn key_id(self, input: impl Into<String>) -> Self

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn set_key_id(self, input: Option<String>) -> Self

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn get_key_id(&self) -> &Option<String>

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn grant_id(self, input: impl Into<String>) -> Self

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn set_grant_id(self, input: Option<String>) -> Self

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn get_grant_id(&self) -> &Option<String>

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn dry_run(self, input: bool) -> Self

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

pub fn get_dry_run(&self) -> &Option<bool>

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

pub fn build(self) -> Result<RetireGrantInput, BuildError>

Consumes the builder and constructs a RetireGrantInput.

impl RetireGrantInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<RetireGrantOutput, SdkError<RetireGrantError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for RetireGrantInputBuilder

fn clone(&self) -> RetireGrantInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetireGrantInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetireGrantInputBuilder

fn default() -> RetireGrantInputBuilder

Returns the “default value” for a type.

impl PartialEq for RetireGrantInputBuilder

fn eq(&self, other: &RetireGrantInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RetireGrantInputBuilder