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
// 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 CreateScanInput {
/// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
pub client_token: ::std::option::Option<::std::string::String>,
/// <p>The identifier for the resource object to be scanned.</p>
pub resource_id: ::std::option::Option<crate::types::ResourceId>,
/// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
pub scan_name: ::std::option::Option<::std::string::String>,
/// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
/// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
pub scan_type: ::std::option::Option<crate::types::ScanType>,
/// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
pub analysis_type: ::std::option::Option<crate::types::AnalysisType>,
/// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
/// <ul>
/// <li>
/// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
/// <li>
/// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
/// </ul>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateScanInput {
/// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
/// <p>The identifier for the resource object to be scanned.</p>
pub fn resource_id(&self) -> ::std::option::Option<&crate::types::ResourceId> {
self.resource_id.as_ref()
}
/// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
pub fn scan_name(&self) -> ::std::option::Option<&str> {
self.scan_name.as_deref()
}
/// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
/// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
pub fn scan_type(&self) -> ::std::option::Option<&crate::types::ScanType> {
self.scan_type.as_ref()
}
/// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
pub fn analysis_type(&self) -> ::std::option::Option<&crate::types::AnalysisType> {
self.analysis_type.as_ref()
}
/// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
/// <ul>
/// <li>
/// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
/// <li>
/// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
/// </ul>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
}
impl CreateScanInput {
/// Creates a new builder-style object to manufacture [`CreateScanInput`](crate::operation::create_scan::CreateScanInput).
pub fn builder() -> crate::operation::create_scan::builders::CreateScanInputBuilder {
crate::operation::create_scan::builders::CreateScanInputBuilder::default()
}
}
/// A builder for [`CreateScanInput`](crate::operation::create_scan::CreateScanInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateScanInputBuilder {
pub(crate) client_token: ::std::option::Option<::std::string::String>,
pub(crate) resource_id: ::std::option::Option<crate::types::ResourceId>,
pub(crate) scan_name: ::std::option::Option<::std::string::String>,
pub(crate) scan_type: ::std::option::Option<crate::types::ScanType>,
pub(crate) analysis_type: ::std::option::Option<crate::types::AnalysisType>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateScanInputBuilder {
/// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</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>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// <p>The identifier for the resource object to be scanned.</p>
/// This field is required.
pub fn resource_id(mut self, input: crate::types::ResourceId) -> Self {
self.resource_id = ::std::option::Option::Some(input);
self
}
/// <p>The identifier for the resource object to be scanned.</p>
pub fn set_resource_id(mut self, input: ::std::option::Option<crate::types::ResourceId>) -> Self {
self.resource_id = input;
self
}
/// <p>The identifier for the resource object to be scanned.</p>
pub fn get_resource_id(&self) -> &::std::option::Option<crate::types::ResourceId> {
&self.resource_id
}
/// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
/// This field is required.
pub fn scan_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scan_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
pub fn set_scan_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scan_name = input;
self
}
/// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
pub fn get_scan_name(&self) -> &::std::option::Option<::std::string::String> {
&self.scan_name
}
/// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
/// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
pub fn scan_type(mut self, input: crate::types::ScanType) -> Self {
self.scan_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
/// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
pub fn set_scan_type(mut self, input: ::std::option::Option<crate::types::ScanType>) -> Self {
self.scan_type = input;
self
}
/// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
/// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
pub fn get_scan_type(&self) -> &::std::option::Option<crate::types::ScanType> {
&self.scan_type
}
/// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
pub fn analysis_type(mut self, input: crate::types::AnalysisType) -> Self {
self.analysis_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
pub fn set_analysis_type(mut self, input: ::std::option::Option<crate::types::AnalysisType>) -> Self {
self.analysis_type = input;
self
}
/// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
pub fn get_analysis_type(&self) -> &::std::option::Option<crate::types::AnalysisType> {
&self.analysis_type
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
/// <ul>
/// <li>
/// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
/// <li>
/// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
/// </ul>
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>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
/// <ul>
/// <li>
/// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
/// <li>
/// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
/// </ul>
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>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
/// <ul>
/// <li>
/// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
/// <li>
/// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
/// </ul>
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 [`CreateScanInput`](crate::operation::create_scan::CreateScanInput).
pub fn build(self) -> ::std::result::Result<crate::operation::create_scan::CreateScanInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_scan::CreateScanInput {
client_token: self.client_token,
resource_id: self.resource_id,
scan_name: self.scan_name,
scan_type: self.scan_type,
analysis_type: self.analysis_type,
tags: self.tags,
})
}
}