aws-sdk-location 1.69.0

AWS SDK for Amazon Location Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DeleteKeyInput {
    /// <p>The name of the API key to delete.</p>
    pub key_name: ::std::option::Option<::std::string::String>,
    /// <p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p>
    /// <p>Valid values: <code>true</code>, or <code>false</code>.</p>
    /// <p>Required: No</p><note>
    /// <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p>
    /// </note>
    pub force_delete: ::std::option::Option<bool>,
}
impl DeleteKeyInput {
    /// <p>The name of the API key to delete.</p>
    pub fn key_name(&self) -> ::std::option::Option<&str> {
        self.key_name.as_deref()
    }
    /// <p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p>
    /// <p>Valid values: <code>true</code>, or <code>false</code>.</p>
    /// <p>Required: No</p><note>
    /// <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p>
    /// </note>
    pub fn force_delete(&self) -> ::std::option::Option<bool> {
        self.force_delete
    }
}
impl DeleteKeyInput {
    /// Creates a new builder-style object to manufacture [`DeleteKeyInput`](crate::operation::delete_key::DeleteKeyInput).
    pub fn builder() -> crate::operation::delete_key::builders::DeleteKeyInputBuilder {
        crate::operation::delete_key::builders::DeleteKeyInputBuilder::default()
    }
}

/// A builder for [`DeleteKeyInput`](crate::operation::delete_key::DeleteKeyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DeleteKeyInputBuilder {
    pub(crate) key_name: ::std::option::Option<::std::string::String>,
    pub(crate) force_delete: ::std::option::Option<bool>,
}
impl DeleteKeyInputBuilder {
    /// <p>The name of the API key to delete.</p>
    /// This field is required.
    pub fn key_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the API key to delete.</p>
    pub fn set_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key_name = input;
        self
    }
    /// <p>The name of the API key to delete.</p>
    pub fn get_key_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.key_name
    }
    /// <p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p>
    /// <p>Valid values: <code>true</code>, or <code>false</code>.</p>
    /// <p>Required: No</p><note>
    /// <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p>
    /// </note>
    pub fn force_delete(mut self, input: bool) -> Self {
        self.force_delete = ::std::option::Option::Some(input);
        self
    }
    /// <p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p>
    /// <p>Valid values: <code>true</code>, or <code>false</code>.</p>
    /// <p>Required: No</p><note>
    /// <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p>
    /// </note>
    pub fn set_force_delete(mut self, input: ::std::option::Option<bool>) -> Self {
        self.force_delete = input;
        self
    }
    /// <p>ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter <code>true</code> to delete the key or to <code>false</code> to not preemptively delete the API key.</p>
    /// <p>Valid values: <code>true</code>, or <code>false</code>.</p>
    /// <p>Required: No</p><note>
    /// <p>This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.</p>
    /// </note>
    pub fn get_force_delete(&self) -> &::std::option::Option<bool> {
        &self.force_delete
    }
    /// Consumes the builder and constructs a [`DeleteKeyInput`](crate::operation::delete_key::DeleteKeyInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::delete_key::DeleteKeyInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::delete_key::DeleteKeyInput {
            key_name: self.key_name,
            force_delete: self.force_delete,
        })
    }
}