Skip to content

/AWS1/CL_SNB=>UPDATECLUSTER()

About UpdateCluster

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.

Method Signature

IMPORTING

Required arguments:

IV_CLUSTERID TYPE /AWS1/SNBCLUSTERID /AWS1/SNBCLUSTERID

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

Optional arguments:

IV_ROLEARN TYPE /AWS1/SNBROLEARN /AWS1/SNBROLEARN

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

IV_DESCRIPTION TYPE /AWS1/SNBSTRING /AWS1/SNBSTRING

The updated description of this cluster.

IO_RESOURCES TYPE REF TO /AWS1/CL_SNBJOBRESOURCE /AWS1/CL_SNBJOBRESOURCE

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

IO_ONDEVICESERVICECONF TYPE REF TO /AWS1/CL_SNBONDEVICESVCCONF /AWS1/CL_SNBONDEVICESVCCONF

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

IV_ADDRESSID TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID

The ID of the updated Address object.

IV_SHIPPINGOPTION TYPE /AWS1/SNBSHIPPINGOPTION /AWS1/SNBSHIPPINGOPTION

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

IO_NOTIFICATION TYPE REF TO /AWS1/CL_SNBNOTIFICATION /AWS1/CL_SNBNOTIFICATION

The new or updated Notification object.

IV_FORWARDINGADDRESSID TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SNBUPDATECLUSTRESULT /AWS1/CL_SNBUPDATECLUSTRESULT