aws-sdk-securityagent 1.8.0

AWS SDK for AWS Security Agent
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

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

/// <p>Input for creating a new threat model.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateThreatModelInput {
    /// <p>The title of the threat model.</p>
    pub title: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier of the agent space to create the threat model in.</p>
    pub agent_space_id: ::std::option::Option<::std::string::String>,
    /// <p>A description of the application or system being threat modeled.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The assets to include in the threat model.</p>
    pub assets: ::std::option::Option<crate::types::Assets>,
    /// <p>The scoped documents for the agent to focus on during threat modeling.</p>
    pub scope_docs: ::std::option::Option<::std::vec::Vec<crate::types::DocumentInfo>>,
    /// <p>The IAM service role to use for the threat model.</p>
    pub service_role: ::std::option::Option<::std::string::String>,
    /// <p>The CloudWatch Logs configuration for the threat model.</p>
    pub log_config: ::std::option::Option<crate::types::CloudWatchLog>,
    /// <p>The destination for publishing scan reports to an integrated document provider.</p>
    pub report_destination: ::std::option::Option<crate::types::ReportDestination>,
}
impl CreateThreatModelInput {
    /// <p>The title of the threat model.</p>
    pub fn title(&self) -> ::std::option::Option<&str> {
        self.title.as_deref()
    }
    /// <p>The unique identifier of the agent space to create the threat model in.</p>
    pub fn agent_space_id(&self) -> ::std::option::Option<&str> {
        self.agent_space_id.as_deref()
    }
    /// <p>A description of the application or system being threat modeled.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The assets to include in the threat model.</p>
    pub fn assets(&self) -> ::std::option::Option<&crate::types::Assets> {
        self.assets.as_ref()
    }
    /// <p>The scoped documents for the agent to focus on during threat modeling.</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 `.scope_docs.is_none()`.
    pub fn scope_docs(&self) -> &[crate::types::DocumentInfo] {
        self.scope_docs.as_deref().unwrap_or_default()
    }
    /// <p>The IAM service role to use for the threat model.</p>
    pub fn service_role(&self) -> ::std::option::Option<&str> {
        self.service_role.as_deref()
    }
    /// <p>The CloudWatch Logs configuration for the threat model.</p>
    pub fn log_config(&self) -> ::std::option::Option<&crate::types::CloudWatchLog> {
        self.log_config.as_ref()
    }
    /// <p>The destination for publishing scan reports to an integrated document provider.</p>
    pub fn report_destination(&self) -> ::std::option::Option<&crate::types::ReportDestination> {
        self.report_destination.as_ref()
    }
}
impl CreateThreatModelInput {
    /// Creates a new builder-style object to manufacture [`CreateThreatModelInput`](crate::operation::create_threat_model::CreateThreatModelInput).
    pub fn builder() -> crate::operation::create_threat_model::builders::CreateThreatModelInputBuilder {
        crate::operation::create_threat_model::builders::CreateThreatModelInputBuilder::default()
    }
}

/// A builder for [`CreateThreatModelInput`](crate::operation::create_threat_model::CreateThreatModelInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateThreatModelInputBuilder {
    pub(crate) title: ::std::option::Option<::std::string::String>,
    pub(crate) agent_space_id: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) assets: ::std::option::Option<crate::types::Assets>,
    pub(crate) scope_docs: ::std::option::Option<::std::vec::Vec<crate::types::DocumentInfo>>,
    pub(crate) service_role: ::std::option::Option<::std::string::String>,
    pub(crate) log_config: ::std::option::Option<crate::types::CloudWatchLog>,
    pub(crate) report_destination: ::std::option::Option<crate::types::ReportDestination>,
}
impl CreateThreatModelInputBuilder {
    /// <p>The title of the threat model.</p>
    /// This field is required.
    pub fn title(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.title = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The title of the threat model.</p>
    pub fn set_title(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.title = input;
        self
    }
    /// <p>The title of the threat model.</p>
    pub fn get_title(&self) -> &::std::option::Option<::std::string::String> {
        &self.title
    }
    /// <p>The unique identifier of the agent space to create the threat model in.</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 to create the threat model in.</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 to create the threat model in.</p>
    pub fn get_agent_space_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.agent_space_id
    }
    /// <p>A description of the application or system being threat modeled.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the application or system being threat modeled.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the application or system being threat modeled.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The assets to include in the threat model.</p>
    pub fn assets(mut self, input: crate::types::Assets) -> Self {
        self.assets = ::std::option::Option::Some(input);
        self
    }
    /// <p>The assets to include in the threat model.</p>
    pub fn set_assets(mut self, input: ::std::option::Option<crate::types::Assets>) -> Self {
        self.assets = input;
        self
    }
    /// <p>The assets to include in the threat model.</p>
    pub fn get_assets(&self) -> &::std::option::Option<crate::types::Assets> {
        &self.assets
    }
    /// Appends an item to `scope_docs`.
    ///
    /// To override the contents of this collection use [`set_scope_docs`](Self::set_scope_docs).
    ///
    /// <p>The scoped documents for the agent to focus on during threat modeling.</p>
    pub fn scope_docs(mut self, input: crate::types::DocumentInfo) -> Self {
        let mut v = self.scope_docs.unwrap_or_default();
        v.push(input);
        self.scope_docs = ::std::option::Option::Some(v);
        self
    }
    /// <p>The scoped documents for the agent to focus on during threat modeling.</p>
    pub fn set_scope_docs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentInfo>>) -> Self {
        self.scope_docs = input;
        self
    }
    /// <p>The scoped documents for the agent to focus on during threat modeling.</p>
    pub fn get_scope_docs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentInfo>> {
        &self.scope_docs
    }
    /// <p>The IAM service role to use for the threat model.</p>
    /// This field is required.
    pub fn service_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.service_role = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The IAM service role to use for the threat model.</p>
    pub fn set_service_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.service_role = input;
        self
    }
    /// <p>The IAM service role to use for the threat model.</p>
    pub fn get_service_role(&self) -> &::std::option::Option<::std::string::String> {
        &self.service_role
    }
    /// <p>The CloudWatch Logs configuration for the threat model.</p>
    pub fn log_config(mut self, input: crate::types::CloudWatchLog) -> Self {
        self.log_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The CloudWatch Logs configuration for the threat model.</p>
    pub fn set_log_config(mut self, input: ::std::option::Option<crate::types::CloudWatchLog>) -> Self {
        self.log_config = input;
        self
    }
    /// <p>The CloudWatch Logs configuration for the threat model.</p>
    pub fn get_log_config(&self) -> &::std::option::Option<crate::types::CloudWatchLog> {
        &self.log_config
    }
    /// <p>The destination for publishing scan reports to an integrated document provider.</p>
    pub fn report_destination(mut self, input: crate::types::ReportDestination) -> Self {
        self.report_destination = ::std::option::Option::Some(input);
        self
    }
    /// <p>The destination for publishing scan reports to an integrated document provider.</p>
    pub fn set_report_destination(mut self, input: ::std::option::Option<crate::types::ReportDestination>) -> Self {
        self.report_destination = input;
        self
    }
    /// <p>The destination for publishing scan reports to an integrated document provider.</p>
    pub fn get_report_destination(&self) -> &::std::option::Option<crate::types::ReportDestination> {
        &self.report_destination
    }
    /// Consumes the builder and constructs a [`CreateThreatModelInput`](crate::operation::create_threat_model::CreateThreatModelInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_threat_model::CreateThreatModelInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_threat_model::CreateThreatModelInput {
            title: self.title,
            agent_space_id: self.agent_space_id,
            description: self.description,
            assets: self.assets,
            scope_docs: self.scope_docs,
            service_role: self.service_role,
            log_config: self.log_config,
            report_destination: self.report_destination,
        })
    }
}