aws-sdk-networksecuritymanager 1.2.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 UpdatePolicyInput {
    /// <p>The identifier of the policy. This is the policy's Amazon Resource Name (ARN).</p>
    pub policy_identifier: ::std::option::Option<::std::string::String>,
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub update_token: ::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 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>).</p>
    pub is_published: ::std::option::Option<bool>,
    /// <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>,
}
impl UpdatePolicyInput {
    /// <p>The identifier of the policy. This is the policy's Amazon Resource Name (ARN).</p>
    pub fn policy_identifier(&self) -> ::std::option::Option<&str> {
        self.policy_identifier.as_deref()
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn update_token(&self) -> ::std::option::Option<&str> {
        self.update_token.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 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>).</p>
    pub fn is_published(&self) -> ::std::option::Option<bool> {
        self.is_published
    }
    /// <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()
    }
}
impl UpdatePolicyInput {
    /// Creates a new builder-style object to manufacture [`UpdatePolicyInput`](crate::operation::update_policy::UpdatePolicyInput).
    pub fn builder() -> crate::operation::update_policy::builders::UpdatePolicyInputBuilder {
        crate::operation::update_policy::builders::UpdatePolicyInputBuilder::default()
    }
}

/// A builder for [`UpdatePolicyInput`](crate::operation::update_policy::UpdatePolicyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdatePolicyInputBuilder {
    pub(crate) policy_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) update_token: ::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) policy_configuration: ::std::option::Option<crate::types::PolicyConfiguration>,
    pub(crate) is_published: ::std::option::Option<bool>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl UpdatePolicyInputBuilder {
    /// <p>The identifier of the policy. This is the policy's Amazon Resource Name (ARN).</p>
    /// This field is required.
    pub fn policy_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.policy_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the policy. This is the policy's Amazon Resource Name (ARN).</p>
    pub fn set_policy_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.policy_identifier = input;
        self
    }
    /// <p>The identifier of the policy. This is the policy's Amazon Resource Name (ARN).</p>
    pub fn get_policy_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.policy_identifier
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    /// This field is required.
    pub fn update_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.update_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn set_update_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.update_token = input;
        self
    }
    /// <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
    pub fn get_update_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.update_token
    }
    /// <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>
    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 configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>
    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>).</p>
    /// This field is required.
    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>).</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>).</p>
    pub fn get_is_published(&self) -> &::std::option::Option<bool> {
        &self.is_published
    }
    /// <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
    }
    /// Consumes the builder and constructs a [`UpdatePolicyInput`](crate::operation::update_policy::UpdatePolicyInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_policy::UpdatePolicyInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_policy::UpdatePolicyInput {
            policy_identifier: self.policy_identifier,
            update_token: self.update_token,
            policy_description: self.policy_description,
            priority: self.priority,
            associated_template_and_rule_list: self.associated_template_and_rule_list,
            policy_configuration: self.policy_configuration,
            is_published: self.is_published,
            client_token: self.client_token,
        })
    }
}