AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class CreateClusterRequest : AmazonSnowballRequest
         IAmazonWebServiceRequest

The CreateClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateClusterRequest()

Properties

NameTypeDescription
Public Property AddressId System.String

Gets and sets the property AddressId.

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

Public Property Description System.String

Gets and sets the property Description.

An optional description of this specific cluster, for example

Environmental
            Data Cluster-01
.

Public Property ForwardingAddressId System.String

Gets and sets the property ForwardingAddressId.

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

Public Property 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.

Public Property 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 AWS Key Management Service (AWS KMS).

Public Property Notification Amazon.Snowball.Model.Notification

Gets and sets the property Notification.

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

Public Property 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 AWS Lambda functions written in the Python language.

Public Property 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 AWS Identity and Access Management (IAM).

Public Property 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 appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

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

  • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

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

Public Property SnowballType Amazon.Snowball.SnowballType

Gets and sets the property SnowballType.

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

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 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 {
                        
        },
        NotifyAll = false
    },
    Resources = new JobResource { S3Resources = new List {
        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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms