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.

Contains metadata about a specific cluster.

Inheritance Hierarchy

System.Object
  Amazon.Snowball.Model.ClusterMetadata

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

Syntax

C#
public class ClusterMetadata

The ClusterMetadata type exposes the following members

Constructors

NameDescription
Public Method ClusterMetadata()

Properties

NameTypeDescription
Public Property AddressId System.String

Gets and sets the property AddressId.

The automatically generated ID for a specific address.

Public Property ClusterId System.String

Gets and sets the property ClusterId.

The automatically generated ID for a cluster.

Public Property ClusterState Amazon.Snowball.ClusterState

Gets and sets the property ClusterState.

The current status of the cluster.

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The creation date for this cluster.

Public Property Description System.String

Gets and sets the property Description.

The optional description of the cluster.

Public Property ForwardingAddressId System.String

Gets and sets the property ForwardingAddressId.

The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. 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 Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (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 OnDeviceServiceConfiguration Amazon.Snowball.Model.OnDeviceServiceConfiguration

Gets and sets the property OnDeviceServiceConfiguration.

Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

Public Property Resources Amazon.Snowball.Model.JobResource

Gets and sets the property Resources.

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Public Property RoleARN System.String

Gets and sets the property RoleARN.

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in 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 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, 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.

Public Property SnowballType Amazon.Snowball.SnowballType

Gets and sets the property SnowballType.

The type of Snowcone device to use for this cluster.

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

Public Property TaxDocuments Amazon.Snowball.Model.TaxDocuments

Gets and sets the property TaxDocuments.

The tax documents required in your Amazon Web Services Region.

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