Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CreateClusterRequest

import type { CreateClusterRequest } from "https://aws-api.deno.dev/v0.3/services/snowball.ts?docs=full";
interface CreateClusterRequest {
AddressId: string;
Description?: string | null;
ForwardingAddressId?: string | null;
JobType: JobType;
KmsKeyARN?: string | null;
Notification?: Notification | null;
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration | null;
RemoteManagement?: RemoteManagement | null;
Resources: JobResource;
RoleARN: string;
ShippingOption: ShippingOption;
SnowballType: SnowballType;
TaxDocuments?: TaxDocuments | null;
}

§Properties

§
AddressId: string
[src]

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

§
Description?: string | null
[src]

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

§
ForwardingAddressId?: string | null
[src]

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

§
JobType: JobType
[src]

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

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

§
KmsKeyARN?: string | null
[src]

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

§
Notification?: Notification | null
[src]

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

§
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration | null
[src]

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?: RemoteManagement | null
[src]

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: JobResource
[src]

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

§
RoleARN: string
[src]

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: ShippingOption
[src]

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:

  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.

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

  • In India, Snow devices are delivered in one to seven days.

  • In the United States of America (US), you have access to one-day shipping and two-day shipping.

  • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

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

  • In India, Snow devices are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

§
SnowballType: SnowballType
[src]

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

Note: For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

§
TaxDocuments?: TaxDocuments | null
[src]

The tax documents required in your Amazon Web Services Region.