CreateClusterRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateCluster operation. Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Snowball.AmazonSnowballRequest
      Amazon.Snowball.Model.CreateClusterRequest

Namespace: Amazon.Snowball.Model
Assembly: AWSSDK.Snowball.dll
Version: 3.x.y.z

Syntax

public class CreateClusterRequest : AmazonSnowballRequest
         IAmazonWebServiceRequest

The CreateClusterRequest type exposes the following members

Constructors

	Name	Description
	CreateClusterRequest()

Properties

Name	Type	Description
AddressId	System.String	Gets and sets the property AddressId. The ID for the address that you want the cluster shipped to.
Description	System.String	Gets and sets the property Description. An optional description of this specific cluster, for example `Environmental Data Cluster-01`.
ForceCreateJobs	System.Boolean	Gets and sets the property ForceCreateJobs. 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	System.String	Gets and sets the property ForwardingAddressId. The forwarding address ID for a cluster. This field is not supported in most regions.
InitialClusterSize	System.Int32	Gets and sets the property InitialClusterSize. If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
JobType	Amazon.Snowball.JobType	Gets and sets the property JobType. 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	System.String	Gets and sets the property KmsKeyARN. 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	System.Collections.Generic.List<System.String>	Gets and sets the property LongTermPricingIds. Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
Notification	Amazon.Snowball.Model.Notification	Gets and sets the property Notification. The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
OnDeviceServiceConfiguration	Amazon.Snowball.Model.OnDeviceServiceConfiguration	Gets and sets the property 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	Amazon.Snowball.RemoteManagement	Gets and sets the property 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	Amazon.Snowball.Model.JobResource	Gets and sets the property Resources. The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
RoleARN	System.String	Gets and sets the property RoleARN. 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	Amazon.Snowball.ShippingOption	Gets and sets the property 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: 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.
SnowballCapacityPreference	Amazon.Snowball.SnowballCapacity	Gets and sets the property SnowballCapacityPreference. 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. 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.
SnowballType	Amazon.Snowball.SnowballType	Gets and sets the property SnowballType. The type of Snow Family devices to use for this cluster. 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	Amazon.Snowball.Model.TaxDocuments	Gets and sets the property TaxDocuments. The tax documents required in your Amazon Web Services Region.

Examples

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

To create a cluster


var client = new AmazonSnowballClient();
var response = client.CreateCluster(new CreateClusterRequest 
{
    AddressId = "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
    Description = "MyCluster",
    JobType = "LOCAL_USE",
    KmsKeyARN = "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
    Notification = new Notification {
        JobStatesToNotify = new List<string> {
                        
        },
        NotifyAll = false
    },
    Resources = new JobResource { S3Resources = new List<S3Resource> {
        new S3Resource {
            BucketArn = "arn:aws:s3:::MyBucket",
            KeyRange = new KeyRange {  }
        }
    } },
    RoleARN = "arn:aws:iam::123456789012:role/snowball-import-S3-role",
    ShippingOption = "SECOND_DAY",
    SnowballType = "EDGE"
});

string clusterId = response.ClusterId;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5