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 UpdateScopeInput {
    /// <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
    pub scope_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 scope.</p>
    pub scope_description: ::std::option::Option<::std::string::String>,
    /// <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p>
    /// <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
    pub scope_configuration: ::std::option::Option<crate::types::ScopeConfiguration>,
    /// <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 UpdateScopeInput {
    /// <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
    pub fn scope_identifier(&self) -> ::std::option::Option<&str> {
        self.scope_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 scope.</p>
    pub fn scope_description(&self) -> ::std::option::Option<&str> {
        self.scope_description.as_deref()
    }
    /// <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p>
    /// <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
    pub fn scope_configuration(&self) -> ::std::option::Option<&crate::types::ScopeConfiguration> {
        self.scope_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 UpdateScopeInput {
    /// Creates a new builder-style object to manufacture [`UpdateScopeInput`](crate::operation::update_scope::UpdateScopeInput).
    pub fn builder() -> crate::operation::update_scope::builders::UpdateScopeInputBuilder {
        crate::operation::update_scope::builders::UpdateScopeInputBuilder::default()
    }
}

/// A builder for [`UpdateScopeInput`](crate::operation::update_scope::UpdateScopeInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateScopeInputBuilder {
    pub(crate) scope_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) update_token: ::std::option::Option<::std::string::String>,
    pub(crate) scope_description: ::std::option::Option<::std::string::String>,
    pub(crate) scope_configuration: ::std::option::Option<crate::types::ScopeConfiguration>,
    pub(crate) is_published: ::std::option::Option<bool>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl UpdateScopeInputBuilder {
    /// <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
    /// This field is required.
    pub fn scope_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
    pub fn set_scope_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_identifier = input;
        self
    }
    /// <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
    pub fn get_scope_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_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 scope.</p>
    pub fn scope_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scope_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the scope.</p>
    pub fn set_scope_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scope_description = input;
        self
    }
    /// <p>A description of the scope.</p>
    pub fn get_scope_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.scope_description
    }
    /// <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p>
    /// <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
    pub fn scope_configuration(mut self, input: crate::types::ScopeConfiguration) -> Self {
        self.scope_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p>
    /// <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
    pub fn set_scope_configuration(mut self, input: ::std::option::Option<crate::types::ScopeConfiguration>) -> Self {
        self.scope_configuration = input;
        self
    }
    /// <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p>
    /// <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
    pub fn get_scope_configuration(&self) -> &::std::option::Option<crate::types::ScopeConfiguration> {
        &self.scope_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 [`UpdateScopeInput`](crate::operation::update_scope::UpdateScopeInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::update_scope::UpdateScopeInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_scope::UpdateScopeInput {
            scope_identifier: self.scope_identifier,
            update_token: self.update_token,
            scope_description: self.scope_description,
            scope_configuration: self.scope_configuration,
            is_published: self.is_published,
            client_token: self.client_token,
        })
    }
}