aws-sdk-networksecuritymanager 1.1.0

AWS SDK for AWS Network Security Manager Customer API
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 CreatePolicyInput {
    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>The name of the policy.</p>
    pub policy_name: ::std::option::Option<::std::string::String>,
    /// <p>A description of the policy.</p>
    pub policy_description: ::std::option::Option<::std::string::String>,
    /// <p>The priority of the resource. A lower number indicates a higher priority.</p>
    pub priority: ::std::option::Option<i32>,
    /// <p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>
    pub associated_template_and_rule_list: ::std::option::Option<::std::vec::Vec<crate::types::TemplateOrRuleReference>>,
    /// <p>The firewall type associated with the resource.</p>
    pub firewall_type: ::std::option::Option<crate::types::PolicyFirewallType>,
    /// <p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    pub policy_configuration: ::std::option::Option<crate::types::PolicyConfiguration>,
    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
    pub is_published: ::std::option::Option<bool>,
    /// <p>The tags to add to the resource when it is created.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreatePolicyInput {
    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>The name of the policy.</p>
    pub fn policy_name(&self) -> ::std::option::Option<&str> {
        self.policy_name.as_deref()
    }
    /// <p>A description of the policy.</p>
    pub fn policy_description(&self) -> ::std::option::Option<&str> {
        self.policy_description.as_deref()
    }
    /// <p>The priority of the resource. A lower number indicates a higher priority.</p>
    pub fn priority(&self) -> ::std::option::Option<i32> {
        self.priority
    }
    /// <p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.associated_template_and_rule_list.is_none()`.
    pub fn associated_template_and_rule_list(&self) -> &[crate::types::TemplateOrRuleReference] {
        self.associated_template_and_rule_list.as_deref().unwrap_or_default()
    }
    /// <p>The firewall type associated with the resource.</p>
    pub fn firewall_type(&self) -> ::std::option::Option<&crate::types::PolicyFirewallType> {
        self.firewall_type.as_ref()
    }
    /// <p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    pub fn policy_configuration(&self) -> ::std::option::Option<&crate::types::PolicyConfiguration> {
        self.policy_configuration.as_ref()
    }
    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
    pub fn is_published(&self) -> ::std::option::Option<bool> {
        self.is_published
    }
    /// <p>The tags to add to the resource when it is created.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl CreatePolicyInput {
    /// Creates a new builder-style object to manufacture [`CreatePolicyInput`](crate::operation::create_policy::CreatePolicyInput).
    pub fn builder() -> crate::operation::create_policy::builders::CreatePolicyInputBuilder {
        crate::operation::create_policy::builders::CreatePolicyInputBuilder::default()
    }
}

/// A builder for [`CreatePolicyInput`](crate::operation::create_policy::CreatePolicyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreatePolicyInputBuilder {
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) policy_name: ::std::option::Option<::std::string::String>,
    pub(crate) policy_description: ::std::option::Option<::std::string::String>,
    pub(crate) priority: ::std::option::Option<i32>,
    pub(crate) associated_template_and_rule_list: ::std::option::Option<::std::vec::Vec<crate::types::TemplateOrRuleReference>>,
    pub(crate) firewall_type: ::std::option::Option<crate::types::PolicyFirewallType>,
    pub(crate) policy_configuration: ::std::option::Option<crate::types::PolicyConfiguration>,
    pub(crate) is_published: ::std::option::Option<bool>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreatePolicyInputBuilder {
    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// <p>The name of the policy.</p>
    /// This field is required.
    pub fn policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.policy_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the policy.</p>
    pub fn set_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.policy_name = input;
        self
    }
    /// <p>The name of the policy.</p>
    pub fn get_policy_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.policy_name
    }
    /// <p>A description of the policy.</p>
    pub fn policy_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.policy_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the policy.</p>
    pub fn set_policy_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.policy_description = input;
        self
    }
    /// <p>A description of the policy.</p>
    pub fn get_policy_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.policy_description
    }
    /// <p>The priority of the resource. A lower number indicates a higher priority.</p>
    /// This field is required.
    pub fn priority(mut self, input: i32) -> Self {
        self.priority = ::std::option::Option::Some(input);
        self
    }
    /// <p>The priority of the resource. A lower number indicates a higher priority.</p>
    pub fn set_priority(mut self, input: ::std::option::Option<i32>) -> Self {
        self.priority = input;
        self
    }
    /// <p>The priority of the resource. A lower number indicates a higher priority.</p>
    pub fn get_priority(&self) -> &::std::option::Option<i32> {
        &self.priority
    }
    /// Appends an item to `associated_template_and_rule_list`.
    ///
    /// To override the contents of this collection use [`set_associated_template_and_rule_list`](Self::set_associated_template_and_rule_list).
    ///
    /// <p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>
    pub fn associated_template_and_rule_list(mut self, input: crate::types::TemplateOrRuleReference) -> Self {
        let mut v = self.associated_template_and_rule_list.unwrap_or_default();
        v.push(input);
        self.associated_template_and_rule_list = ::std::option::Option::Some(v);
        self
    }
    /// <p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>
    pub fn set_associated_template_and_rule_list(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::TemplateOrRuleReference>>,
    ) -> Self {
        self.associated_template_and_rule_list = input;
        self
    }
    /// <p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>
    pub fn get_associated_template_and_rule_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TemplateOrRuleReference>> {
        &self.associated_template_and_rule_list
    }
    /// <p>The firewall type associated with the resource.</p>
    /// This field is required.
    pub fn firewall_type(mut self, input: crate::types::PolicyFirewallType) -> Self {
        self.firewall_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The firewall type associated with the resource.</p>
    pub fn set_firewall_type(mut self, input: ::std::option::Option<crate::types::PolicyFirewallType>) -> Self {
        self.firewall_type = input;
        self
    }
    /// <p>The firewall type associated with the resource.</p>
    pub fn get_firewall_type(&self) -> &::std::option::Option<crate::types::PolicyFirewallType> {
        &self.firewall_type
    }
    /// <p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    /// This field is required.
    pub fn policy_configuration(mut self, input: crate::types::PolicyConfiguration) -> Self {
        self.policy_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    pub fn set_policy_configuration(mut self, input: ::std::option::Option<crate::types::PolicyConfiguration>) -> Self {
        self.policy_configuration = input;
        self
    }
    /// <p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    pub fn get_policy_configuration(&self) -> &::std::option::Option<crate::types::PolicyConfiguration> {
        &self.policy_configuration
    }
    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
    pub fn is_published(mut self, input: bool) -> Self {
        self.is_published = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
    pub fn set_is_published(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_published = input;
        self
    }
    /// <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
    pub fn get_is_published(&self) -> &::std::option::Option<bool> {
        &self.is_published
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags to add to the resource when it is created.</p>
    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>The tags to add to the resource when it is created.</p>
    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>The tags to add to the resource when it is created.</p>
    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 [`CreatePolicyInput`](crate::operation::create_policy::CreatePolicyInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_policy::CreatePolicyInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_policy::CreatePolicyInput {
            client_token: self.client_token,
            policy_name: self.policy_name,
            policy_description: self.policy_description,
            priority: self.priority,
            associated_template_and_rule_list: self.associated_template_and_rule_list,
            firewall_type: self.firewall_type,
            policy_configuration: self.policy_configuration,
            is_published: self.is_published,
            tags: self.tags,
        })
    }
}