aws_sdk_securityagent/operation/create_threat/

_create_threat_input.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Input for creating a new threat.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateThreatInput {
    /// <p>The unique identifier of the agent space.</p>
    pub agent_space_id: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier of the threat model job the threat belongs to.</p>
    pub threat_job_id: ::std::option::Option<::std::string::String>,
    /// <p>A short title summarizing the threat.</p>
    pub title: ::std::option::Option<::std::string::String>,
    /// <p>The natural-language threat statement.</p>
    pub statement: ::std::option::Option<::std::string::String>,
    /// <p>The severity level of the threat.</p>
    pub severity: ::std::option::Option<crate::types::ThreatSeverity>,
    /// <p>Optional customer comment on the threat.</p>
    pub comments: ::std::option::Option<::std::string::String>,
    /// <p>The STRIDE categories applicable to this threat.</p>
    pub stride: ::std::option::Option<::std::vec::Vec<crate::types::StrideCategory>>,
    /// <p>The actor or origin of the threat.</p>
    pub threat_source: ::std::option::Option<::std::string::String>,
    /// <p>The conditions required for the threat to be exploitable.</p>
    pub prerequisites: ::std::option::Option<::std::string::String>,
    /// <p>What the threat source can do.</p>
    pub threat_action: ::std::option::Option<::std::string::String>,
    /// <p>The direct consequence of the threat action.</p>
    pub threat_impact: ::std::option::Option<::std::string::String>,
    /// <p>The security goals affected by the threat.</p>
    pub impacted_goal: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The specific assets affected by the threat.</p>
    pub impacted_assets: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The DFD element this threat is anchored to.</p>
    pub anchor: ::std::option::Option<crate::types::ThreatAnchorShape>,
    /// <p>The source code files supporting the threat.</p>
    pub evidence: ::std::option::Option<::std::vec::Vec<crate::types::ThreatEvidenceShape>>,
    /// <p>The recommended mitigation guidance for this threat.</p>
    pub recommendation: ::std::option::Option<::std::string::String>,
}
impl CreateThreatInput {
    /// <p>The unique identifier of the agent space.</p>
    pub fn agent_space_id(&self) -> ::std::option::Option<&str> {
        self.agent_space_id.as_deref()
    }
    /// <p>The unique identifier of the threat model job the threat belongs to.</p>
    pub fn threat_job_id(&self) -> ::std::option::Option<&str> {
        self.threat_job_id.as_deref()
    }
    /// <p>A short title summarizing the threat.</p>
    pub fn title(&self) -> ::std::option::Option<&str> {
        self.title.as_deref()
    }
    /// <p>The natural-language threat statement.</p>
    pub fn statement(&self) -> ::std::option::Option<&str> {
        self.statement.as_deref()
    }
    /// <p>The severity level of the threat.</p>
    pub fn severity(&self) -> ::std::option::Option<&crate::types::ThreatSeverity> {
        self.severity.as_ref()
    }
    /// <p>Optional customer comment on the threat.</p>
    pub fn comments(&self) -> ::std::option::Option<&str> {
        self.comments.as_deref()
    }
    /// <p>The STRIDE categories applicable to this threat.</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 `.stride.is_none()`.
    pub fn stride(&self) -> &[crate::types::StrideCategory] {
        self.stride.as_deref().unwrap_or_default()
    }
    /// <p>The actor or origin of the threat.</p>
    pub fn threat_source(&self) -> ::std::option::Option<&str> {
        self.threat_source.as_deref()
    }
    /// <p>The conditions required for the threat to be exploitable.</p>
    pub fn prerequisites(&self) -> ::std::option::Option<&str> {
        self.prerequisites.as_deref()
    }
    /// <p>What the threat source can do.</p>
    pub fn threat_action(&self) -> ::std::option::Option<&str> {
        self.threat_action.as_deref()
    }
    /// <p>The direct consequence of the threat action.</p>
    pub fn threat_impact(&self) -> ::std::option::Option<&str> {
        self.threat_impact.as_deref()
    }
    /// <p>The security goals affected by the threat.</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 `.impacted_goal.is_none()`.
    pub fn impacted_goal(&self) -> &[::std::string::String] {
        self.impacted_goal.as_deref().unwrap_or_default()
    }
    /// <p>The specific assets affected by the threat.</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 `.impacted_assets.is_none()`.
    pub fn impacted_assets(&self) -> &[::std::string::String] {
        self.impacted_assets.as_deref().unwrap_or_default()
    }
    /// <p>The DFD element this threat is anchored to.</p>
    pub fn anchor(&self) -> ::std::option::Option<&crate::types::ThreatAnchorShape> {
        self.anchor.as_ref()
    }
    /// <p>The source code files supporting the threat.</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 `.evidence.is_none()`.
    pub fn evidence(&self) -> &[crate::types::ThreatEvidenceShape] {
        self.evidence.as_deref().unwrap_or_default()
    }
    /// <p>The recommended mitigation guidance for this threat.</p>
    pub fn recommendation(&self) -> ::std::option::Option<&str> {
        self.recommendation.as_deref()
    }
}
impl CreateThreatInput {
    /// Creates a new builder-style object to manufacture [`CreateThreatInput`](crate::operation::create_threat::CreateThreatInput).
    pub fn builder() -> crate::operation::create_threat::builders::CreateThreatInputBuilder {
        crate::operation::create_threat::builders::CreateThreatInputBuilder::default()
    }
}

/// A builder for [`CreateThreatInput`](crate::operation::create_threat::CreateThreatInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateThreatInputBuilder {
    pub(crate) agent_space_id: ::std::option::Option<::std::string::String>,
    pub(crate) threat_job_id: ::std::option::Option<::std::string::String>,
    pub(crate) title: ::std::option::Option<::std::string::String>,
    pub(crate) statement: ::std::option::Option<::std::string::String>,
    pub(crate) severity: ::std::option::Option<crate::types::ThreatSeverity>,
    pub(crate) comments: ::std::option::Option<::std::string::String>,
    pub(crate) stride: ::std::option::Option<::std::vec::Vec<crate::types::StrideCategory>>,
    pub(crate) threat_source: ::std::option::Option<::std::string::String>,
    pub(crate) prerequisites: ::std::option::Option<::std::string::String>,
    pub(crate) threat_action: ::std::option::Option<::std::string::String>,
    pub(crate) threat_impact: ::std::option::Option<::std::string::String>,
    pub(crate) impacted_goal: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) impacted_assets: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) anchor: ::std::option::Option<crate::types::ThreatAnchorShape>,
    pub(crate) evidence: ::std::option::Option<::std::vec::Vec<crate::types::ThreatEvidenceShape>>,
    pub(crate) recommendation: ::std::option::Option<::std::string::String>,
}
impl CreateThreatInputBuilder {
    /// <p>The unique identifier of the agent space.</p>
    /// This field is required.
    pub fn agent_space_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.agent_space_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the agent space.</p>
    pub fn set_agent_space_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.agent_space_id = input;
        self
    }
    /// <p>The unique identifier of the agent space.</p>
    pub fn get_agent_space_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.agent_space_id
    }
    /// <p>The unique identifier of the threat model job the threat belongs to.</p>
    /// This field is required.
    pub fn threat_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.threat_job_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the threat model job the threat belongs to.</p>
    pub fn set_threat_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.threat_job_id = input;
        self
    }
    /// <p>The unique identifier of the threat model job the threat belongs to.</p>
    pub fn get_threat_job_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.threat_job_id
    }
    /// <p>A short title summarizing the threat.</p>
    pub fn title(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.title = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A short title summarizing the threat.</p>
    pub fn set_title(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.title = input;
        self
    }
    /// <p>A short title summarizing the threat.</p>
    pub fn get_title(&self) -> &::std::option::Option<::std::string::String> {
        &self.title
    }
    /// <p>The natural-language threat statement.</p>
    pub fn statement(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.statement = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The natural-language threat statement.</p>
    pub fn set_statement(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.statement = input;
        self
    }
    /// <p>The natural-language threat statement.</p>
    pub fn get_statement(&self) -> &::std::option::Option<::std::string::String> {
        &self.statement
    }
    /// <p>The severity level of the threat.</p>
    pub fn severity(mut self, input: crate::types::ThreatSeverity) -> Self {
        self.severity = ::std::option::Option::Some(input);
        self
    }
    /// <p>The severity level of the threat.</p>
    pub fn set_severity(mut self, input: ::std::option::Option<crate::types::ThreatSeverity>) -> Self {
        self.severity = input;
        self
    }
    /// <p>The severity level of the threat.</p>
    pub fn get_severity(&self) -> &::std::option::Option<crate::types::ThreatSeverity> {
        &self.severity
    }
    /// <p>Optional customer comment on the threat.</p>
    pub fn comments(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.comments = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Optional customer comment on the threat.</p>
    pub fn set_comments(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.comments = input;
        self
    }
    /// <p>Optional customer comment on the threat.</p>
    pub fn get_comments(&self) -> &::std::option::Option<::std::string::String> {
        &self.comments
    }
    /// Appends an item to `stride`.
    ///
    /// To override the contents of this collection use [`set_stride`](Self::set_stride).
    ///
    /// <p>The STRIDE categories applicable to this threat.</p>
    pub fn stride(mut self, input: crate::types::StrideCategory) -> Self {
        let mut v = self.stride.unwrap_or_default();
        v.push(input);
        self.stride = ::std::option::Option::Some(v);
        self
    }
    /// <p>The STRIDE categories applicable to this threat.</p>
    pub fn set_stride(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::StrideCategory>>) -> Self {
        self.stride = input;
        self
    }
    /// <p>The STRIDE categories applicable to this threat.</p>
    pub fn get_stride(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::StrideCategory>> {
        &self.stride
    }
    /// <p>The actor or origin of the threat.</p>
    pub fn threat_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.threat_source = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The actor or origin of the threat.</p>
    pub fn set_threat_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.threat_source = input;
        self
    }
    /// <p>The actor or origin of the threat.</p>
    pub fn get_threat_source(&self) -> &::std::option::Option<::std::string::String> {
        &self.threat_source
    }
    /// <p>The conditions required for the threat to be exploitable.</p>
    pub fn prerequisites(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.prerequisites = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The conditions required for the threat to be exploitable.</p>
    pub fn set_prerequisites(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.prerequisites = input;
        self
    }
    /// <p>The conditions required for the threat to be exploitable.</p>
    pub fn get_prerequisites(&self) -> &::std::option::Option<::std::string::String> {
        &self.prerequisites
    }
    /// <p>What the threat source can do.</p>
    pub fn threat_action(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.threat_action = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>What the threat source can do.</p>
    pub fn set_threat_action(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.threat_action = input;
        self
    }
    /// <p>What the threat source can do.</p>
    pub fn get_threat_action(&self) -> &::std::option::Option<::std::string::String> {
        &self.threat_action
    }
    /// <p>The direct consequence of the threat action.</p>
    pub fn threat_impact(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.threat_impact = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The direct consequence of the threat action.</p>
    pub fn set_threat_impact(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.threat_impact = input;
        self
    }
    /// <p>The direct consequence of the threat action.</p>
    pub fn get_threat_impact(&self) -> &::std::option::Option<::std::string::String> {
        &self.threat_impact
    }
    /// Appends an item to `impacted_goal`.
    ///
    /// To override the contents of this collection use [`set_impacted_goal`](Self::set_impacted_goal).
    ///
    /// <p>The security goals affected by the threat.</p>
    pub fn impacted_goal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.impacted_goal.unwrap_or_default();
        v.push(input.into());
        self.impacted_goal = ::std::option::Option::Some(v);
        self
    }
    /// <p>The security goals affected by the threat.</p>
    pub fn set_impacted_goal(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.impacted_goal = input;
        self
    }
    /// <p>The security goals affected by the threat.</p>
    pub fn get_impacted_goal(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.impacted_goal
    }
    /// Appends an item to `impacted_assets`.
    ///
    /// To override the contents of this collection use [`set_impacted_assets`](Self::set_impacted_assets).
    ///
    /// <p>The specific assets affected by the threat.</p>
    pub fn impacted_assets(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.impacted_assets.unwrap_or_default();
        v.push(input.into());
        self.impacted_assets = ::std::option::Option::Some(v);
        self
    }
    /// <p>The specific assets affected by the threat.</p>
    pub fn set_impacted_assets(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.impacted_assets = input;
        self
    }
    /// <p>The specific assets affected by the threat.</p>
    pub fn get_impacted_assets(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.impacted_assets
    }
    /// <p>The DFD element this threat is anchored to.</p>
    pub fn anchor(mut self, input: crate::types::ThreatAnchorShape) -> Self {
        self.anchor = ::std::option::Option::Some(input);
        self
    }
    /// <p>The DFD element this threat is anchored to.</p>
    pub fn set_anchor(mut self, input: ::std::option::Option<crate::types::ThreatAnchorShape>) -> Self {
        self.anchor = input;
        self
    }
    /// <p>The DFD element this threat is anchored to.</p>
    pub fn get_anchor(&self) -> &::std::option::Option<crate::types::ThreatAnchorShape> {
        &self.anchor
    }
    /// Appends an item to `evidence`.
    ///
    /// To override the contents of this collection use [`set_evidence`](Self::set_evidence).
    ///
    /// <p>The source code files supporting the threat.</p>
    pub fn evidence(mut self, input: crate::types::ThreatEvidenceShape) -> Self {
        let mut v = self.evidence.unwrap_or_default();
        v.push(input);
        self.evidence = ::std::option::Option::Some(v);
        self
    }
    /// <p>The source code files supporting the threat.</p>
    pub fn set_evidence(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ThreatEvidenceShape>>) -> Self {
        self.evidence = input;
        self
    }
    /// <p>The source code files supporting the threat.</p>
    pub fn get_evidence(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ThreatEvidenceShape>> {
        &self.evidence
    }
    /// <p>The recommended mitigation guidance for this threat.</p>
    pub fn recommendation(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.recommendation = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The recommended mitigation guidance for this threat.</p>
    pub fn set_recommendation(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.recommendation = input;
        self
    }
    /// <p>The recommended mitigation guidance for this threat.</p>
    pub fn get_recommendation(&self) -> &::std::option::Option<::std::string::String> {
        &self.recommendation
    }
    /// Consumes the builder and constructs a [`CreateThreatInput`](crate::operation::create_threat::CreateThreatInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_threat::CreateThreatInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_threat::CreateThreatInput {
            agent_space_id: self.agent_space_id,
            threat_job_id: self.threat_job_id,
            title: self.title,
            statement: self.statement,
            severity: self.severity,
            comments: self.comments,
            stride: self.stride,
            threat_source: self.threat_source,
            prerequisites: self.prerequisites,
            threat_action: self.threat_action,
            threat_impact: self.threat_impact,
            impacted_goal: self.impacted_goal,
            impacted_assets: self.impacted_assets,
            anchor: self.anchor,
            evidence: self.evidence,
            recommendation: self.recommendation,
        })
    }
}