class Aws::Snowball::Types::UpdateClusterRequest

@note When making an API call, you may pass UpdateClusterRequest

data as a hash:

    {
      cluster_id: "ClusterId", # required
      role_arn: "RoleARN",
      description: "String",
      resources: {
        s3_resources: [
          {
            bucket_arn: "ResourceARN",
            key_range: {
              begin_marker: "String",
              end_marker: "String",
            },
            target_on_device_services: [
              {
                service_name: "NFS_ON_DEVICE_SERVICE", # accepts NFS_ON_DEVICE_SERVICE, S3_ON_DEVICE_SERVICE
                transfer_option: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
              },
            ],
          },
        ],
        lambda_resources: [
          {
            lambda_arn: "ResourceARN",
            event_triggers: [
              {
                event_resource_arn: "ResourceARN",
              },
            ],
          },
        ],
        ec2_ami_resources: [
          {
            ami_id: "AmiId", # required
            snowball_ami_id: "String",
          },
        ],
      },
      on_device_service_configuration: {
        nfs_on_device_service: {
          storage_limit: 1,
          storage_unit: "TB", # accepts TB
        },
      },
      address_id: "AddressId",
      shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
      notification: {
        sns_topic_arn: "SnsTopicARN",
        job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
        notify_all: false,
      },
      forwarding_address_id: "AddressId",
    }

@!attribute [rw] cluster_id

The cluster ID of the cluster that you want to update, for example
`CID123e4567-e89b-12d3-a456-426655440000`.
@return [String]

@!attribute [rw] role_arn

The new role Amazon Resource Name (ARN) that you want to associate
with this cluster. To create a role ARN, use the [CreateRole][1] API
action in AWS Identity and Access Management (IAM).

[1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
@return [String]

@!attribute [rw] description

The updated description of this cluster.
@return [String]

@!attribute [rw] resources

The updated arrays of JobResource objects that can include updated
S3Resource objects or LambdaResource objects.
@return [Types::JobResource]

@!attribute [rw] on_device_service_configuration

Specifies the service or services on the Snow Family device that
your transferred data will be exported from or imported into. AWS
Snow Family supports Amazon S3 and NFS (Network File System).
@return [Types::OnDeviceServiceConfiguration]

@!attribute [rw] address_id

The ID of the updated Address object.
@return [String]

@!attribute [rw] shipping_option

The updated shipping option value of this cluster's ShippingDetails
object.
@return [String]

@!attribute [rw] notification

The new or updated Notification object.
@return [Types::Notification]

@!attribute [rw] forwarding_address_id

The updated ID for the forwarding address for a cluster. This field
is not supported in most regions.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateClusterRequest AWS API Documentation

Constants

SENSITIVE