You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Snowball::Types::UpdateClusterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

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",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  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, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  forwarding_address_id: "AddressId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The ID of the updated Address object.

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#cluster_idString

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

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#descriptionString

The updated description of this cluster.

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#forwarding_address_idString

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

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#notificationTypes::Notification

The new or updated Notification object.

Returns:



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#resourcesTypes::JobResource

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

Returns:



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#shipping_optionString

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

Returns:

  • (String)


1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1664

class UpdateClusterRequest < Struct.new(
  :cluster_id,
  :role_arn,
  :description,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end