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 UpdateCluster operation. While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Inheritance Hierarchy

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

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

Syntax

C#
public class UpdateClusterRequest : AmazonSnowballRequest
         IAmazonWebServiceRequest

The UpdateClusterRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateClusterRequest()

Properties

NameTypeDescription
Public Property AddressId System.String

Gets and sets the property AddressId.

The ID of the updated Address object.

Public Property ClusterId System.String

Gets and sets the property ClusterId.

The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

Public Property Description System.String

Gets and sets the property Description.

The updated description of this cluster.

Public Property ForwardingAddressId System.String

Gets and sets the property ForwardingAddressId.

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

Public Property Notification Amazon.Snowball.Model.Notification

Gets and sets the property Notification.

The new or updated Notification object.

Public Property Resources Amazon.Snowball.Model.JobResource

Gets and sets the property Resources.

The updated 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 new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

Public Property ShippingOption Amazon.Snowball.ShippingOption

Gets and sets the property ShippingOption.

The updated shipping option value of this cluster's ShippingDetails object.

Examples

This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.

To update a cluster


var response = client.UpdateCluster(new UpdateClusterRequest 
{
    AddressId = "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
    ClusterId = "CID123e4567-e89b-12d3-a456-426655440000",
    Description = "Updated the address to send this to image processing - RJ"
});


            

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