Class: Aws::Snowball::Types::UpdateClusterRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Snowball::Types::UpdateClusterRequest
- Defined in:
- gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb
Overview
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
},
tgw_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",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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
.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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).
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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).
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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.
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 2777 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 |