snowball/aws.sdk.kotlin.services.snowball.model/CreateClusterRequest/Builder

Builder

class Builder

Properties

addressId

var addressId: String?

The ID for the address that you want the cluster shipped to.

description

var description: String?

An optional description of this specific cluster, for example Environmental Data Cluster-01.

forceCreateJobs

var forceCreateJobs: Boolean?

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 OnDeviceServiceConfiguration.

forwardingAddressId

var forwardingAddressId: String?

The forwarding address ID for a cluster. This field is not supported in most regions.

initialClusterSize

var initialClusterSize: Int?

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

jobType

var jobType: JobType?

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

kmsKeyArn

var kmsKeyArn: String?

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).

longTermPricingIds

var longTermPricingIds: List<String>?

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

notification

var notification: Notification?

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

onDeviceServiceConfiguration

var onDeviceServiceConfiguration: OnDeviceServiceConfiguration?

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).

remoteManagement

var remoteManagement: RemoteManagement?

Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, 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.

resources

var resources: JobResource?

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.

roleArn

var roleArn: String?

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).

shippingOption

var shippingOption: ShippingOption?

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:

snowballCapacityPreference

var snowballCapacityPreference: SnowballCapacity?

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.

snowballType

var snowballType: SnowballType?

The type of Snow Family devices to use for this cluster.

taxDocuments

var taxDocuments: TaxDocuments?

The tax documents required in your Amazon Web Services Region.