aws-sdk-iot 1.112.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, ::std::fmt::Debug)]
pub struct CreateAuthorizerInput {
    /// <p>The authorizer name.</p>
    pub authorizer_name: ::std::option::Option<::std::string::String>,
    /// <p>The ARN of the authorizer's Lambda function.</p>
    pub authorizer_function_arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the token key used to extract the token from the HTTP headers.</p>
    pub token_key_name: ::std::option::Option<::std::string::String>,
    /// <p>The public keys used to verify the digital signature returned by your custom authentication service.</p>
    pub token_signing_public_keys: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The status of the create authorizer request.</p>
    pub status: ::std::option::Option<crate::types::AuthorizerStatus>,
    /// <p>Metadata which can be used to manage the custom authorizer.</p><note>
    /// <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p>
    /// <p>For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..."</p>
    /// <p>For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."</p>
    /// </note>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    /// <p>Specifies whether IoT validates the token signature in an authorization request.</p>
    pub signing_disabled: ::std::option::Option<bool>,
    /// <p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p>
    /// <p>The default value is <code>false</code>.</p>
    pub enable_caching_for_http: ::std::option::Option<bool>,
}
impl CreateAuthorizerInput {
    /// <p>The authorizer name.</p>
    pub fn authorizer_name(&self) -> ::std::option::Option<&str> {
        self.authorizer_name.as_deref()
    }
    /// <p>The ARN of the authorizer's Lambda function.</p>
    pub fn authorizer_function_arn(&self) -> ::std::option::Option<&str> {
        self.authorizer_function_arn.as_deref()
    }
    /// <p>The name of the token key used to extract the token from the HTTP headers.</p>
    pub fn token_key_name(&self) -> ::std::option::Option<&str> {
        self.token_key_name.as_deref()
    }
    /// <p>The public keys used to verify the digital signature returned by your custom authentication service.</p>
    pub fn token_signing_public_keys(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.token_signing_public_keys.as_ref()
    }
    /// <p>The status of the create authorizer request.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::AuthorizerStatus> {
        self.status.as_ref()
    }
    /// <p>Metadata which can be used to manage the custom authorizer.</p><note>
    /// <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p>
    /// <p>For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..."</p>
    /// <p>For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."</p>
    /// </note>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
    /// <p>Specifies whether IoT validates the token signature in an authorization request.</p>
    pub fn signing_disabled(&self) -> ::std::option::Option<bool> {
        self.signing_disabled
    }
    /// <p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p>
    /// <p>The default value is <code>false</code>.</p>
    pub fn enable_caching_for_http(&self) -> ::std::option::Option<bool> {
        self.enable_caching_for_http
    }
}
impl CreateAuthorizerInput {
    /// Creates a new builder-style object to manufacture [`CreateAuthorizerInput`](crate::operation::create_authorizer::CreateAuthorizerInput).
    pub fn builder() -> crate::operation::create_authorizer::builders::CreateAuthorizerInputBuilder {
        crate::operation::create_authorizer::builders::CreateAuthorizerInputBuilder::default()
    }
}

/// A builder for [`CreateAuthorizerInput`](crate::operation::create_authorizer::CreateAuthorizerInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateAuthorizerInputBuilder {
    pub(crate) authorizer_name: ::std::option::Option<::std::string::String>,
    pub(crate) authorizer_function_arn: ::std::option::Option<::std::string::String>,
    pub(crate) token_key_name: ::std::option::Option<::std::string::String>,
    pub(crate) token_signing_public_keys: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) status: ::std::option::Option<crate::types::AuthorizerStatus>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    pub(crate) signing_disabled: ::std::option::Option<bool>,
    pub(crate) enable_caching_for_http: ::std::option::Option<bool>,
}
impl CreateAuthorizerInputBuilder {
    /// <p>The authorizer name.</p>
    /// This field is required.
    pub fn authorizer_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.authorizer_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The authorizer name.</p>
    pub fn set_authorizer_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.authorizer_name = input;
        self
    }
    /// <p>The authorizer name.</p>
    pub fn get_authorizer_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.authorizer_name
    }
    /// <p>The ARN of the authorizer's Lambda function.</p>
    /// This field is required.
    pub fn authorizer_function_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.authorizer_function_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the authorizer's Lambda function.</p>
    pub fn set_authorizer_function_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.authorizer_function_arn = input;
        self
    }
    /// <p>The ARN of the authorizer's Lambda function.</p>
    pub fn get_authorizer_function_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.authorizer_function_arn
    }
    /// <p>The name of the token key used to extract the token from the HTTP headers.</p>
    pub fn token_key_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.token_key_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the token key used to extract the token from the HTTP headers.</p>
    pub fn set_token_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.token_key_name = input;
        self
    }
    /// <p>The name of the token key used to extract the token from the HTTP headers.</p>
    pub fn get_token_key_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.token_key_name
    }
    /// Adds a key-value pair to `token_signing_public_keys`.
    ///
    /// To override the contents of this collection use [`set_token_signing_public_keys`](Self::set_token_signing_public_keys).
    ///
    /// <p>The public keys used to verify the digital signature returned by your custom authentication service.</p>
    pub fn token_signing_public_keys(
        mut self,
        k: impl ::std::convert::Into<::std::string::String>,
        v: impl ::std::convert::Into<::std::string::String>,
    ) -> Self {
        let mut hash_map = self.token_signing_public_keys.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.token_signing_public_keys = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The public keys used to verify the digital signature returned by your custom authentication service.</p>
    pub fn set_token_signing_public_keys(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    ) -> Self {
        self.token_signing_public_keys = input;
        self
    }
    /// <p>The public keys used to verify the digital signature returned by your custom authentication service.</p>
    pub fn get_token_signing_public_keys(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.token_signing_public_keys
    }
    /// <p>The status of the create authorizer request.</p>
    pub fn status(mut self, input: crate::types::AuthorizerStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the create authorizer request.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::AuthorizerStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the create authorizer request.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::AuthorizerStatus> {
        &self.status
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Metadata which can be used to manage the custom authorizer.</p><note>
    /// <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p>
    /// <p>For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..."</p>
    /// <p>For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."</p>
    /// </note>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>Metadata which can be used to manage the custom authorizer.</p><note>
    /// <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p>
    /// <p>For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..."</p>
    /// <p>For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."</p>
    /// </note>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Metadata which can be used to manage the custom authorizer.</p><note>
    /// <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p>
    /// <p>For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..."</p>
    /// <p>For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."</p>
    /// </note>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// <p>Specifies whether IoT validates the token signature in an authorization request.</p>
    pub fn signing_disabled(mut self, input: bool) -> Self {
        self.signing_disabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies whether IoT validates the token signature in an authorization request.</p>
    pub fn set_signing_disabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.signing_disabled = input;
        self
    }
    /// <p>Specifies whether IoT validates the token signature in an authorization request.</p>
    pub fn get_signing_disabled(&self) -> &::std::option::Option<bool> {
        &self.signing_disabled
    }
    /// <p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p>
    /// <p>The default value is <code>false</code>.</p>
    pub fn enable_caching_for_http(mut self, input: bool) -> Self {
        self.enable_caching_for_http = ::std::option::Option::Some(input);
        self
    }
    /// <p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p>
    /// <p>The default value is <code>false</code>.</p>
    pub fn set_enable_caching_for_http(mut self, input: ::std::option::Option<bool>) -> Self {
        self.enable_caching_for_http = input;
        self
    }
    /// <p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value does not affect authorization of clients that use MQTT connections.</p>
    /// <p>The default value is <code>false</code>.</p>
    pub fn get_enable_caching_for_http(&self) -> &::std::option::Option<bool> {
        &self.enable_caching_for_http
    }
    /// Consumes the builder and constructs a [`CreateAuthorizerInput`](crate::operation::create_authorizer::CreateAuthorizerInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_authorizer::CreateAuthorizerInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_authorizer::CreateAuthorizerInput {
            authorizer_name: self.authorizer_name,
            authorizer_function_arn: self.authorizer_function_arn,
            token_key_name: self.token_key_name,
            token_signing_public_keys: self.token_signing_public_keys,
            status: self.status,
            tags: self.tags,
            signing_disabled: self.signing_disabled,
            enable_caching_for_http: self.enable_caching_for_http,
        })
    }
}