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

Inherits:

Struct

• Object
• Struct
• Aws::Snowball::Types::UpdateClusterRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-snowball/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #address_id ⇒ String

  The ID of the updated Address object.

• #cluster_id ⇒ String

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

• #description ⇒ String

  The updated description of this cluster.

• #forwarding_address_id ⇒ String

  The updated ID for the forwarding address for a cluster.

• #notification ⇒ Types::Notification

  The new or updated Notification object.

• #on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

  Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.

• #resources ⇒ Types::JobResource

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

• #role_arn ⇒ String

  The new role Amazon Resource Name (ARN) that you want to associate with this cluster.

• #shipping_option ⇒ String

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

Instance Attribute Details

#address_id ⇒ String

The ID of the updated Address object.

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#cluster_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#description ⇒ String

The updated description of this cluster.

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#forwarding_address_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#notification ⇒ Types::Notification

The new or updated Notification object.

Returns:

• (Types::Notification)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

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

Returns:

• (Types::OnDeviceServiceConfiguration)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#resources ⇒ Types::JobResource

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

Returns:

• (Types::JobResource)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#role_arn ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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

#shipping_option ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-snowball/types.rb', line 2567

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