aws_sdk_quicksight/operation/create_dashboard/_create_dashboard_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct CreateDashboardInput {
6 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
7 pub aws_account_id: ::std::option::Option<::std::string::String>,
8 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
9 pub dashboard_id: ::std::option::Option<::std::string::String>,
10 /// <p>The display name of the dashboard.</p>
11 pub name: ::std::option::Option<::std::string::String>,
12 /// <p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>
13 pub parameters: ::std::option::Option<crate::types::Parameters>,
14 /// <p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.</p>
15 /// <p>To specify no permissions, omit the permissions list.</p>
16 pub permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
17 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.</p>
18 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
19 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
20 pub source_entity: ::std::option::Option<crate::types::DashboardSourceEntity>,
21 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
22 pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
23 /// <p>A description for the first version of the dashboard being created.</p>
24 pub version_description: ::std::option::Option<::std::string::String>,
25 /// <p>Options for publishing the dashboard when you create it:</p>
26 /// <ul>
27 /// <li>
28 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
29 /// <li>
30 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
31 /// <li>
32 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
33 /// </ul>
34 pub dashboard_publish_options: ::std::option::Option<crate::types::DashboardPublishOptions>,
35 /// <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.</p>
36 pub theme_arn: ::std::option::Option<::std::string::String>,
37 /// <p>The definition of a dashboard.</p>
38 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
39 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
40 pub definition: ::std::option::Option<crate::types::DashboardVersionDefinition>,
41 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
42 pub validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
43 /// <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
44 pub folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
45 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
46 pub link_sharing_configuration: ::std::option::Option<crate::types::LinkSharingConfiguration>,
47 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
48 pub link_entities: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
49}
50impl CreateDashboardInput {
51 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
52 pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
53 self.aws_account_id.as_deref()
54 }
55 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
56 pub fn dashboard_id(&self) -> ::std::option::Option<&str> {
57 self.dashboard_id.as_deref()
58 }
59 /// <p>The display name of the dashboard.</p>
60 pub fn name(&self) -> ::std::option::Option<&str> {
61 self.name.as_deref()
62 }
63 /// <p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>
64 pub fn parameters(&self) -> ::std::option::Option<&crate::types::Parameters> {
65 self.parameters.as_ref()
66 }
67 /// <p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.</p>
68 /// <p>To specify no permissions, omit the permissions list.</p>
69 ///
70 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.permissions.is_none()`.
71 pub fn permissions(&self) -> &[crate::types::ResourcePermission] {
72 self.permissions.as_deref().unwrap_or_default()
73 }
74 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.</p>
75 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
76 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
77 pub fn source_entity(&self) -> ::std::option::Option<&crate::types::DashboardSourceEntity> {
78 self.source_entity.as_ref()
79 }
80 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
81 ///
82 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
83 pub fn tags(&self) -> &[crate::types::Tag] {
84 self.tags.as_deref().unwrap_or_default()
85 }
86 /// <p>A description for the first version of the dashboard being created.</p>
87 pub fn version_description(&self) -> ::std::option::Option<&str> {
88 self.version_description.as_deref()
89 }
90 /// <p>Options for publishing the dashboard when you create it:</p>
91 /// <ul>
92 /// <li>
93 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
94 /// <li>
95 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
96 /// <li>
97 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
98 /// </ul>
99 pub fn dashboard_publish_options(&self) -> ::std::option::Option<&crate::types::DashboardPublishOptions> {
100 self.dashboard_publish_options.as_ref()
101 }
102 /// <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.</p>
103 pub fn theme_arn(&self) -> ::std::option::Option<&str> {
104 self.theme_arn.as_deref()
105 }
106 /// <p>The definition of a dashboard.</p>
107 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
108 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
109 pub fn definition(&self) -> ::std::option::Option<&crate::types::DashboardVersionDefinition> {
110 self.definition.as_ref()
111 }
112 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
113 pub fn validation_strategy(&self) -> ::std::option::Option<&crate::types::ValidationStrategy> {
114 self.validation_strategy.as_ref()
115 }
116 /// <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
117 ///
118 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.folder_arns.is_none()`.
119 pub fn folder_arns(&self) -> &[::std::string::String] {
120 self.folder_arns.as_deref().unwrap_or_default()
121 }
122 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
123 pub fn link_sharing_configuration(&self) -> ::std::option::Option<&crate::types::LinkSharingConfiguration> {
124 self.link_sharing_configuration.as_ref()
125 }
126 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
127 ///
128 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.link_entities.is_none()`.
129 pub fn link_entities(&self) -> &[::std::string::String] {
130 self.link_entities.as_deref().unwrap_or_default()
131 }
132}
133impl CreateDashboardInput {
134 /// Creates a new builder-style object to manufacture [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
135 pub fn builder() -> crate::operation::create_dashboard::builders::CreateDashboardInputBuilder {
136 crate::operation::create_dashboard::builders::CreateDashboardInputBuilder::default()
137 }
138}
139
140/// A builder for [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
141#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
142#[non_exhaustive]
143pub struct CreateDashboardInputBuilder {
144 pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
145 pub(crate) dashboard_id: ::std::option::Option<::std::string::String>,
146 pub(crate) name: ::std::option::Option<::std::string::String>,
147 pub(crate) parameters: ::std::option::Option<crate::types::Parameters>,
148 pub(crate) permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
149 pub(crate) source_entity: ::std::option::Option<crate::types::DashboardSourceEntity>,
150 pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
151 pub(crate) version_description: ::std::option::Option<::std::string::String>,
152 pub(crate) dashboard_publish_options: ::std::option::Option<crate::types::DashboardPublishOptions>,
153 pub(crate) theme_arn: ::std::option::Option<::std::string::String>,
154 pub(crate) definition: ::std::option::Option<crate::types::DashboardVersionDefinition>,
155 pub(crate) validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
156 pub(crate) folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
157 pub(crate) link_sharing_configuration: ::std::option::Option<crate::types::LinkSharingConfiguration>,
158 pub(crate) link_entities: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
159}
160impl CreateDashboardInputBuilder {
161 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
162 /// This field is required.
163 pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
164 self.aws_account_id = ::std::option::Option::Some(input.into());
165 self
166 }
167 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
168 pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
169 self.aws_account_id = input;
170 self
171 }
172 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
173 pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
174 &self.aws_account_id
175 }
176 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
177 /// This field is required.
178 pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179 self.dashboard_id = ::std::option::Option::Some(input.into());
180 self
181 }
182 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
183 pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184 self.dashboard_id = input;
185 self
186 }
187 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
188 pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
189 &self.dashboard_id
190 }
191 /// <p>The display name of the dashboard.</p>
192 /// This field is required.
193 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
194 self.name = ::std::option::Option::Some(input.into());
195 self
196 }
197 /// <p>The display name of the dashboard.</p>
198 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
199 self.name = input;
200 self
201 }
202 /// <p>The display name of the dashboard.</p>
203 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
204 &self.name
205 }
206 /// <p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>
207 pub fn parameters(mut self, input: crate::types::Parameters) -> Self {
208 self.parameters = ::std::option::Option::Some(input);
209 self
210 }
211 /// <p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>
212 pub fn set_parameters(mut self, input: ::std::option::Option<crate::types::Parameters>) -> Self {
213 self.parameters = input;
214 self
215 }
216 /// <p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>
217 pub fn get_parameters(&self) -> &::std::option::Option<crate::types::Parameters> {
218 &self.parameters
219 }
220 /// Appends an item to `permissions`.
221 ///
222 /// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
223 ///
224 /// <p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.</p>
225 /// <p>To specify no permissions, omit the permissions list.</p>
226 pub fn permissions(mut self, input: crate::types::ResourcePermission) -> Self {
227 let mut v = self.permissions.unwrap_or_default();
228 v.push(input);
229 self.permissions = ::std::option::Option::Some(v);
230 self
231 }
232 /// <p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.</p>
233 /// <p>To specify no permissions, omit the permissions list.</p>
234 pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>) -> Self {
235 self.permissions = input;
236 self
237 }
238 /// <p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.</p>
239 /// <p>To specify no permissions, omit the permissions list.</p>
240 pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>> {
241 &self.permissions
242 }
243 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.</p>
244 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
245 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
246 pub fn source_entity(mut self, input: crate::types::DashboardSourceEntity) -> Self {
247 self.source_entity = ::std::option::Option::Some(input);
248 self
249 }
250 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.</p>
251 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
252 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
253 pub fn set_source_entity(mut self, input: ::std::option::Option<crate::types::DashboardSourceEntity>) -> Self {
254 self.source_entity = input;
255 self
256 }
257 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.</p>
258 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
259 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
260 pub fn get_source_entity(&self) -> &::std::option::Option<crate::types::DashboardSourceEntity> {
261 &self.source_entity
262 }
263 /// Appends an item to `tags`.
264 ///
265 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
266 ///
267 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
268 pub fn tags(mut self, input: crate::types::Tag) -> Self {
269 let mut v = self.tags.unwrap_or_default();
270 v.push(input);
271 self.tags = ::std::option::Option::Some(v);
272 self
273 }
274 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
275 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
276 self.tags = input;
277 self
278 }
279 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
280 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
281 &self.tags
282 }
283 /// <p>A description for the first version of the dashboard being created.</p>
284 pub fn version_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
285 self.version_description = ::std::option::Option::Some(input.into());
286 self
287 }
288 /// <p>A description for the first version of the dashboard being created.</p>
289 pub fn set_version_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
290 self.version_description = input;
291 self
292 }
293 /// <p>A description for the first version of the dashboard being created.</p>
294 pub fn get_version_description(&self) -> &::std::option::Option<::std::string::String> {
295 &self.version_description
296 }
297 /// <p>Options for publishing the dashboard when you create it:</p>
298 /// <ul>
299 /// <li>
300 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
301 /// <li>
302 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
303 /// <li>
304 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
305 /// </ul>
306 pub fn dashboard_publish_options(mut self, input: crate::types::DashboardPublishOptions) -> Self {
307 self.dashboard_publish_options = ::std::option::Option::Some(input);
308 self
309 }
310 /// <p>Options for publishing the dashboard when you create it:</p>
311 /// <ul>
312 /// <li>
313 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
314 /// <li>
315 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
316 /// <li>
317 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
318 /// </ul>
319 pub fn set_dashboard_publish_options(mut self, input: ::std::option::Option<crate::types::DashboardPublishOptions>) -> Self {
320 self.dashboard_publish_options = input;
321 self
322 }
323 /// <p>Options for publishing the dashboard when you create it:</p>
324 /// <ul>
325 /// <li>
326 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
327 /// <li>
328 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
329 /// <li>
330 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
331 /// </ul>
332 pub fn get_dashboard_publish_options(&self) -> &::std::option::Option<crate::types::DashboardPublishOptions> {
333 &self.dashboard_publish_options
334 }
335 /// <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.</p>
336 pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
337 self.theme_arn = ::std::option::Option::Some(input.into());
338 self
339 }
340 /// <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.</p>
341 pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
342 self.theme_arn = input;
343 self
344 }
345 /// <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.</p>
346 pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
347 &self.theme_arn
348 }
349 /// <p>The definition of a dashboard.</p>
350 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
351 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
352 pub fn definition(mut self, input: crate::types::DashboardVersionDefinition) -> Self {
353 self.definition = ::std::option::Option::Some(input);
354 self
355 }
356 /// <p>The definition of a dashboard.</p>
357 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
358 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
359 pub fn set_definition(mut self, input: ::std::option::Option<crate::types::DashboardVersionDefinition>) -> Self {
360 self.definition = input;
361 self
362 }
363 /// <p>The definition of a dashboard.</p>
364 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
365 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
366 pub fn get_definition(&self) -> &::std::option::Option<crate::types::DashboardVersionDefinition> {
367 &self.definition
368 }
369 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
370 pub fn validation_strategy(mut self, input: crate::types::ValidationStrategy) -> Self {
371 self.validation_strategy = ::std::option::Option::Some(input);
372 self
373 }
374 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
375 pub fn set_validation_strategy(mut self, input: ::std::option::Option<crate::types::ValidationStrategy>) -> Self {
376 self.validation_strategy = input;
377 self
378 }
379 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
380 pub fn get_validation_strategy(&self) -> &::std::option::Option<crate::types::ValidationStrategy> {
381 &self.validation_strategy
382 }
383 /// Appends an item to `folder_arns`.
384 ///
385 /// To override the contents of this collection use [`set_folder_arns`](Self::set_folder_arns).
386 ///
387 /// <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
388 pub fn folder_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
389 let mut v = self.folder_arns.unwrap_or_default();
390 v.push(input.into());
391 self.folder_arns = ::std::option::Option::Some(v);
392 self
393 }
394 /// <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
395 pub fn set_folder_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
396 self.folder_arns = input;
397 self
398 }
399 /// <p>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</p>
400 pub fn get_folder_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
401 &self.folder_arns
402 }
403 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
404 pub fn link_sharing_configuration(mut self, input: crate::types::LinkSharingConfiguration) -> Self {
405 self.link_sharing_configuration = ::std::option::Option::Some(input);
406 self
407 }
408 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
409 pub fn set_link_sharing_configuration(mut self, input: ::std::option::Option<crate::types::LinkSharingConfiguration>) -> Self {
410 self.link_sharing_configuration = input;
411 self
412 }
413 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
414 pub fn get_link_sharing_configuration(&self) -> &::std::option::Option<crate::types::LinkSharingConfiguration> {
415 &self.link_sharing_configuration
416 }
417 /// Appends an item to `link_entities`.
418 ///
419 /// To override the contents of this collection use [`set_link_entities`](Self::set_link_entities).
420 ///
421 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
422 pub fn link_entities(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
423 let mut v = self.link_entities.unwrap_or_default();
424 v.push(input.into());
425 self.link_entities = ::std::option::Option::Some(v);
426 self
427 }
428 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
429 pub fn set_link_entities(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
430 self.link_entities = input;
431 self
432 }
433 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
434 pub fn get_link_entities(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
435 &self.link_entities
436 }
437 /// Consumes the builder and constructs a [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
438 pub fn build(
439 self,
440 ) -> ::std::result::Result<crate::operation::create_dashboard::CreateDashboardInput, ::aws_smithy_types::error::operation::BuildError> {
441 ::std::result::Result::Ok(crate::operation::create_dashboard::CreateDashboardInput {
442 aws_account_id: self.aws_account_id,
443 dashboard_id: self.dashboard_id,
444 name: self.name,
445 parameters: self.parameters,
446 permissions: self.permissions,
447 source_entity: self.source_entity,
448 tags: self.tags,
449 version_description: self.version_description,
450 dashboard_publish_options: self.dashboard_publish_options,
451 theme_arn: self.theme_arn,
452 definition: self.definition,
453 validation_strategy: self.validation_strategy,
454 folder_arns: self.folder_arns,
455 link_sharing_configuration: self.link_sharing_configuration,
456 link_entities: self.link_entities,
457 })
458 }
459}