aws-sdk-location 1.84.0

// 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)]
pub struct CreateKeyInput {
    /// <p>A custom name for the API key resource.</p>
    /// <p>Requirements:</p>
    /// <ul>
    /// <li>
    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
    /// <li>
    /// <p>Must be a unique API key name.</p></li>
    /// <li>
    /// <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p></li>
    /// </ul>
    pub key_name: ::std::option::Option<::std::string::String>,
    /// <p>The API key restrictions for the API key resource.</p>
    pub restrictions: ::std::option::Option<crate::types::ApiKeyRestrictions>,
    /// <p>An optional description for the API key resource.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub expire_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub no_expiry: ::std::option::Option<bool>,
    /// <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.</p>
    /// <p>Format: <code>"key" : "value"</code></p>
    /// <p>Restrictions:</p>
    /// <ul>
    /// <li>
    /// <p>Maximum 50 tags per resource</p></li>
    /// <li>
    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
    /// <li>
    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
    /// <li>
    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
    /// </ul>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateKeyInput {
    /// <p>A custom name for the API key resource.</p>
    /// <p>Requirements:</p>
    /// <ul>
    /// <li>
    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
    /// <li>
    /// <p>Must be a unique API key name.</p></li>
    /// <li>
    /// <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p></li>
    /// </ul>
    pub fn key_name(&self) -> ::std::option::Option<&str> {
        self.key_name.as_deref()
    }
    /// <p>The API key restrictions for the API key resource.</p>
    pub fn restrictions(&self) -> ::std::option::Option<&crate::types::ApiKeyRestrictions> {
        self.restrictions.as_ref()
    }
    /// <p>An optional description for the API key resource.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn expire_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.expire_time.as_ref()
    }
    /// <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn no_expiry(&self) -> ::std::option::Option<bool> {
        self.no_expiry
    }
    /// <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.</p>
    /// <p>Format: <code>"key" : "value"</code></p>
    /// <p>Restrictions:</p>
    /// <ul>
    /// <li>
    /// <p>Maximum 50 tags per resource</p></li>
    /// <li>
    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
    /// <li>
    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
    /// <li>
    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
    /// </ul>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl ::std::fmt::Debug for CreateKeyInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateKeyInput");
        formatter.field("key_name", &self.key_name);
        formatter.field("restrictions", &self.restrictions);
        formatter.field("description", &self.description);
        formatter.field("expire_time", &"*** Sensitive Data Redacted ***");
        formatter.field("no_expiry", &self.no_expiry);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}
impl CreateKeyInput {
    /// Creates a new builder-style object to manufacture [`CreateKeyInput`](crate::operation::create_key::CreateKeyInput).
    pub fn builder() -> crate::operation::create_key::builders::CreateKeyInputBuilder {
        crate::operation::create_key::builders::CreateKeyInputBuilder::default()
    }
}

/// A builder for [`CreateKeyInput`](crate::operation::create_key::CreateKeyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct CreateKeyInputBuilder {
    pub(crate) key_name: ::std::option::Option<::std::string::String>,
    pub(crate) restrictions: ::std::option::Option<crate::types::ApiKeyRestrictions>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) expire_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) no_expiry: ::std::option::Option<bool>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateKeyInputBuilder {
    /// <p>A custom name for the API key resource.</p>
    /// <p>Requirements:</p>
    /// <ul>
    /// <li>
    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
    /// <li>
    /// <p>Must be a unique API key name.</p></li>
    /// <li>
    /// <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p></li>
    /// </ul>
    /// 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>A custom name for the API key resource.</p>
    /// <p>Requirements:</p>
    /// <ul>
    /// <li>
    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
    /// <li>
    /// <p>Must be a unique API key name.</p></li>
    /// <li>
    /// <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p></li>
    /// </ul>
    pub fn set_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key_name = input;
        self
    }
    /// <p>A custom name for the API key resource.</p>
    /// <p>Requirements:</p>
    /// <ul>
    /// <li>
    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
    /// <li>
    /// <p>Must be a unique API key name.</p></li>
    /// <li>
    /// <p>No spaces allowed. For example, <code>ExampleAPIKey</code>.</p></li>
    /// </ul>
    pub fn get_key_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.key_name
    }
    /// <p>The API key restrictions for the API key resource.</p>
    /// This field is required.
    pub fn restrictions(mut self, input: crate::types::ApiKeyRestrictions) -> Self {
        self.restrictions = ::std::option::Option::Some(input);
        self
    }
    /// <p>The API key restrictions for the API key resource.</p>
    pub fn set_restrictions(mut self, input: ::std::option::Option<crate::types::ApiKeyRestrictions>) -> Self {
        self.restrictions = input;
        self
    }
    /// <p>The API key restrictions for the API key resource.</p>
    pub fn get_restrictions(&self) -> &::std::option::Option<crate::types::ApiKeyRestrictions> {
        &self.restrictions
    }
    /// <p>An optional description for the API key resource.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An optional description for the API key resource.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>An optional description for the API key resource.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn expire_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.expire_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn set_expire_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.expire_time = input;
        self
    }
    /// <p>The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn get_expire_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.expire_time
    }
    /// <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn no_expiry(mut self, input: bool) -> Self {
        self.no_expiry = ::std::option::Option::Some(input);
        self
    }
    /// <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn set_no_expiry(mut self, input: ::std::option::Option<bool>) -> Self {
        self.no_expiry = input;
        self
    }
    /// <p>Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.</p>
    pub fn get_no_expiry(&self) -> &::std::option::Option<bool> {
        &self.no_expiry
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.</p>
    /// <p>Format: <code>"key" : "value"</code></p>
    /// <p>Restrictions:</p>
    /// <ul>
    /// <li>
    /// <p>Maximum 50 tags per resource</p></li>
    /// <li>
    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
    /// <li>
    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
    /// <li>
    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
    /// </ul>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.</p>
    /// <p>Format: <code>"key" : "value"</code></p>
    /// <p>Restrictions:</p>
    /// <ul>
    /// <li>
    /// <p>Maximum 50 tags per resource</p></li>
    /// <li>
    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
    /// <li>
    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
    /// <li>
    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
    /// </ul>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.</p>
    /// <p>Format: <code>"key" : "value"</code></p>
    /// <p>Restrictions:</p>
    /// <ul>
    /// <li>
    /// <p>Maximum 50 tags per resource</p></li>
    /// <li>
    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
    /// <li>
    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
    /// <li>
    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
    /// <li>
    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
    /// </ul>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateKeyInput`](crate::operation::create_key::CreateKeyInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::create_key::CreateKeyInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_key::CreateKeyInput {
            key_name: self.key_name,
            restrictions: self.restrictions,
            description: self.description,
            expire_time: self.expire_time,
            no_expiry: self.no_expiry,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for CreateKeyInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateKeyInputBuilder");
        formatter.field("key_name", &self.key_name);
        formatter.field("restrictions", &self.restrictions);
        formatter.field("description", &self.description);
        formatter.field("expire_time", &"*** Sensitive Data Redacted ***");
        formatter.field("no_expiry", &self.no_expiry);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}