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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
// 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 CreateClusterInput {
/// <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub job_type: ::std::option::Option<crate::types::JobType>,
/// <p>The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. </p>
pub resources: ::std::option::Option<crate::types::JobResource>,
/// <p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).</p>
pub on_device_service_configuration: ::std::option::Option<crate::types::OnDeviceServiceConfiguration>,
/// <p>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The ID for the address that you want the cluster shipped to.</p>
pub address_id: ::std::option::Option<::std::string::String>,
/// <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
pub kms_key_arn: ::std::option::Option<::std::string::String>,
/// <p>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>The type of Snow Family devices to use for this cluster. </p> <note>
/// <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p>
/// </note>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub snowball_type: ::std::option::Option<crate::types::SnowballType>,
/// <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
pub shipping_option: ::std::option::Option<crate::types::ShippingOption>,
/// <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.</p>
pub notification: ::std::option::Option<crate::types::Notification>,
/// <p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>
pub forwarding_address_id: ::std::option::Option<::std::string::String>,
/// <p>The tax documents required in your Amazon Web Services Region.</p>
pub tax_documents: ::std::option::Option<crate::types::TaxDocuments>,
/// <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</p>
pub remote_management: ::std::option::Option<crate::types::RemoteManagement>,
/// <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
pub initial_cluster_size: ::std::option::Option<i32>,
/// <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
pub force_create_jobs: ::std::option::Option<bool>,
/// <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
pub long_term_pricing_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub snowball_capacity_preference: ::std::option::Option<crate::types::SnowballCapacity>,
}
impl CreateClusterInput {
/// <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn job_type(&self) -> ::std::option::Option<&crate::types::JobType> {
self.job_type.as_ref()
}
/// <p>The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. </p>
pub fn resources(&self) -> ::std::option::Option<&crate::types::JobResource> {
self.resources.as_ref()
}
/// <p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).</p>
pub fn on_device_service_configuration(&self) -> ::std::option::Option<&crate::types::OnDeviceServiceConfiguration> {
self.on_device_service_configuration.as_ref()
}
/// <p>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The ID for the address that you want the cluster shipped to.</p>
pub fn address_id(&self) -> ::std::option::Option<&str> {
self.address_id.as_deref()
}
/// <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
pub fn kms_key_arn(&self) -> ::std::option::Option<&str> {
self.kms_key_arn.as_deref()
}
/// <p>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>The type of Snow Family devices to use for this cluster. </p> <note>
/// <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p>
/// </note>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn snowball_type(&self) -> ::std::option::Option<&crate::types::SnowballType> {
self.snowball_type.as_ref()
}
/// <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
pub fn shipping_option(&self) -> ::std::option::Option<&crate::types::ShippingOption> {
self.shipping_option.as_ref()
}
/// <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.</p>
pub fn notification(&self) -> ::std::option::Option<&crate::types::Notification> {
self.notification.as_ref()
}
/// <p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>
pub fn forwarding_address_id(&self) -> ::std::option::Option<&str> {
self.forwarding_address_id.as_deref()
}
/// <p>The tax documents required in your Amazon Web Services Region.</p>
pub fn tax_documents(&self) -> ::std::option::Option<&crate::types::TaxDocuments> {
self.tax_documents.as_ref()
}
/// <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</p>
pub fn remote_management(&self) -> ::std::option::Option<&crate::types::RemoteManagement> {
self.remote_management.as_ref()
}
/// <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
pub fn initial_cluster_size(&self) -> ::std::option::Option<i32> {
self.initial_cluster_size
}
/// <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
pub fn force_create_jobs(&self) -> ::std::option::Option<bool> {
self.force_create_jobs
}
/// <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</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 `.long_term_pricing_ids.is_none()`.
pub fn long_term_pricing_ids(&self) -> &[::std::string::String] {
self.long_term_pricing_ids.as_deref().unwrap_or_default()
}
/// <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn snowball_capacity_preference(&self) -> ::std::option::Option<&crate::types::SnowballCapacity> {
self.snowball_capacity_preference.as_ref()
}
}
impl CreateClusterInput {
/// Creates a new builder-style object to manufacture [`CreateClusterInput`](crate::operation::create_cluster::CreateClusterInput).
pub fn builder() -> crate::operation::create_cluster::builders::CreateClusterInputBuilder {
crate::operation::create_cluster::builders::CreateClusterInputBuilder::default()
}
}
/// A builder for [`CreateClusterInput`](crate::operation::create_cluster::CreateClusterInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateClusterInputBuilder {
pub(crate) job_type: ::std::option::Option<crate::types::JobType>,
pub(crate) resources: ::std::option::Option<crate::types::JobResource>,
pub(crate) on_device_service_configuration: ::std::option::Option<crate::types::OnDeviceServiceConfiguration>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) address_id: ::std::option::Option<::std::string::String>,
pub(crate) kms_key_arn: ::std::option::Option<::std::string::String>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) snowball_type: ::std::option::Option<crate::types::SnowballType>,
pub(crate) shipping_option: ::std::option::Option<crate::types::ShippingOption>,
pub(crate) notification: ::std::option::Option<crate::types::Notification>,
pub(crate) forwarding_address_id: ::std::option::Option<::std::string::String>,
pub(crate) tax_documents: ::std::option::Option<crate::types::TaxDocuments>,
pub(crate) remote_management: ::std::option::Option<crate::types::RemoteManagement>,
pub(crate) initial_cluster_size: ::std::option::Option<i32>,
pub(crate) force_create_jobs: ::std::option::Option<bool>,
pub(crate) long_term_pricing_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) snowball_capacity_preference: ::std::option::Option<crate::types::SnowballCapacity>,
}
impl CreateClusterInputBuilder {
/// <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
/// This field is required.
pub fn job_type(mut self, input: crate::types::JobType) -> Self {
self.job_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn set_job_type(mut self, input: ::std::option::Option<crate::types::JobType>) -> Self {
self.job_type = input;
self
}
/// <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn get_job_type(&self) -> &::std::option::Option<crate::types::JobType> {
&self.job_type
}
/// <p>The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. </p>
pub fn resources(mut self, input: crate::types::JobResource) -> Self {
self.resources = ::std::option::Option::Some(input);
self
}
/// <p>The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. </p>
pub fn set_resources(mut self, input: ::std::option::Option<crate::types::JobResource>) -> Self {
self.resources = input;
self
}
/// <p>The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. </p>
pub fn get_resources(&self) -> &::std::option::Option<crate::types::JobResource> {
&self.resources
}
/// <p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).</p>
pub fn on_device_service_configuration(mut self, input: crate::types::OnDeviceServiceConfiguration) -> Self {
self.on_device_service_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).</p>
pub fn set_on_device_service_configuration(mut self, input: ::std::option::Option<crate::types::OnDeviceServiceConfiguration>) -> Self {
self.on_device_service_configuration = input;
self
}
/// <p>Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).</p>
pub fn get_on_device_service_configuration(&self) -> &::std::option::Option<crate::types::OnDeviceServiceConfiguration> {
&self.on_device_service_configuration
}
/// <p>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</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>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The ID for the address that you want the cluster shipped to.</p>
/// This field is required.
pub fn address_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.address_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID for the address that you want the cluster shipped to.</p>
pub fn set_address_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.address_id = input;
self
}
/// <p>The ID for the address that you want the cluster shipped to.</p>
pub fn get_address_id(&self) -> &::std::option::Option<::std::string::String> {
&self.address_id
}
/// <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
pub fn kms_key_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.kms_key_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
pub fn set_kms_key_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_arn = input;
self
}
/// <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
pub fn get_kms_key_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_arn
}
/// <p>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>The type of Snow Family devices to use for this cluster. </p> <note>
/// <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p>
/// </note>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
/// This field is required.
pub fn snowball_type(mut self, input: crate::types::SnowballType) -> Self {
self.snowball_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of Snow Family devices to use for this cluster. </p> <note>
/// <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p>
/// </note>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn set_snowball_type(mut self, input: ::std::option::Option<crate::types::SnowballType>) -> Self {
self.snowball_type = input;
self
}
/// <p>The type of Snow Family devices to use for this cluster. </p> <note>
/// <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p>
/// </note>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn get_snowball_type(&self) -> &::std::option::Option<crate::types::SnowballType> {
&self.snowball_type
}
/// <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// This field is required.
pub fn shipping_option(mut self, input: crate::types::ShippingOption) -> Self {
self.shipping_option = ::std::option::Option::Some(input);
self
}
/// <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
pub fn set_shipping_option(mut self, input: ::std::option::Option<crate::types::ShippingOption>) -> Self {
self.shipping_option = input;
self
}
/// <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
/// <ul>
/// <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li>
/// <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li>
/// <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li>
/// <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li>
/// </ul>
pub fn get_shipping_option(&self) -> &::std::option::Option<crate::types::ShippingOption> {
&self.shipping_option
}
/// <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.</p>
pub fn notification(mut self, input: crate::types::Notification) -> Self {
self.notification = ::std::option::Option::Some(input);
self
}
/// <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.</p>
pub fn set_notification(mut self, input: ::std::option::Option<crate::types::Notification>) -> Self {
self.notification = input;
self
}
/// <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.</p>
pub fn get_notification(&self) -> &::std::option::Option<crate::types::Notification> {
&self.notification
}
/// <p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>
pub fn forwarding_address_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.forwarding_address_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>
pub fn set_forwarding_address_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.forwarding_address_id = input;
self
}
/// <p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>
pub fn get_forwarding_address_id(&self) -> &::std::option::Option<::std::string::String> {
&self.forwarding_address_id
}
/// <p>The tax documents required in your Amazon Web Services Region.</p>
pub fn tax_documents(mut self, input: crate::types::TaxDocuments) -> Self {
self.tax_documents = ::std::option::Option::Some(input);
self
}
/// <p>The tax documents required in your Amazon Web Services Region.</p>
pub fn set_tax_documents(mut self, input: ::std::option::Option<crate::types::TaxDocuments>) -> Self {
self.tax_documents = input;
self
}
/// <p>The tax documents required in your Amazon Web Services Region.</p>
pub fn get_tax_documents(&self) -> &::std::option::Option<crate::types::TaxDocuments> {
&self.tax_documents
}
/// <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</p>
pub fn remote_management(mut self, input: crate::types::RemoteManagement) -> Self {
self.remote_management = ::std::option::Option::Some(input);
self
}
/// <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</p>
pub fn set_remote_management(mut self, input: ::std::option::Option<crate::types::RemoteManagement>) -> Self {
self.remote_management = input;
self
}
/// <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</p>
pub fn get_remote_management(&self) -> &::std::option::Option<crate::types::RemoteManagement> {
&self.remote_management
}
/// <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
pub fn initial_cluster_size(mut self, input: i32) -> Self {
self.initial_cluster_size = ::std::option::Option::Some(input);
self
}
/// <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
pub fn set_initial_cluster_size(mut self, input: ::std::option::Option<i32>) -> Self {
self.initial_cluster_size = input;
self
}
/// <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
pub fn get_initial_cluster_size(&self) -> &::std::option::Option<i32> {
&self.initial_cluster_size
}
/// <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
pub fn force_create_jobs(mut self, input: bool) -> Self {
self.force_create_jobs = ::std::option::Option::Some(input);
self
}
/// <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
pub fn set_force_create_jobs(mut self, input: ::std::option::Option<bool>) -> Self {
self.force_create_jobs = input;
self
}
/// <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
pub fn get_force_create_jobs(&self) -> &::std::option::Option<bool> {
&self.force_create_jobs
}
/// Appends an item to `long_term_pricing_ids`.
///
/// To override the contents of this collection use [`set_long_term_pricing_ids`](Self::set_long_term_pricing_ids).
///
/// <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
pub fn long_term_pricing_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.long_term_pricing_ids.unwrap_or_default();
v.push(input.into());
self.long_term_pricing_ids = ::std::option::Option::Some(v);
self
}
/// <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
pub fn set_long_term_pricing_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.long_term_pricing_ids = input;
self
}
/// <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
pub fn get_long_term_pricing_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.long_term_pricing_ids
}
/// <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn snowball_capacity_preference(mut self, input: crate::types::SnowballCapacity) -> Self {
self.snowball_capacity_preference = ::std::option::Option::Some(input);
self
}
/// <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn set_snowball_capacity_preference(mut self, input: ::std::option::Option<crate::types::SnowballCapacity>) -> Self {
self.snowball_capacity_preference = input;
self
}
/// <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p>
/// <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
pub fn get_snowball_capacity_preference(&self) -> &::std::option::Option<crate::types::SnowballCapacity> {
&self.snowball_capacity_preference
}
/// Consumes the builder and constructs a [`CreateClusterInput`](crate::operation::create_cluster::CreateClusterInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_cluster::CreateClusterInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_cluster::CreateClusterInput {
job_type: self.job_type,
resources: self.resources,
on_device_service_configuration: self.on_device_service_configuration,
description: self.description,
address_id: self.address_id,
kms_key_arn: self.kms_key_arn,
role_arn: self.role_arn,
snowball_type: self.snowball_type,
shipping_option: self.shipping_option,
notification: self.notification,
forwarding_address_id: self.forwarding_address_id,
tax_documents: self.tax_documents,
remote_management: self.remote_management,
initial_cluster_size: self.initial_cluster_size,
force_create_jobs: self.force_create_jobs,
long_term_pricing_ids: self.long_term_pricing_ids,
snowball_capacity_preference: self.snowball_capacity_preference,
})
}
}