You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Snowball::Types::UpdateClusterRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Snowball::Types::UpdateClusterRequest
- Defined in:
- (unknown)
Overview
When passing UpdateClusterRequest as input to an Aws::Client method, you can use a vanilla 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",
},
],
},
],
ec2_ami_resources: [
{
ami_id: "AmiId", # required
snowball_ami_id: "String",
},
],
},
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",
}
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.
-
#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.
#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. This field is not supported in most regions.
#notification ⇒ Types::Notification
The new or updated Notification object.
#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. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).
#shipping_option ⇒ String
The updated shipping option value of this cluster\'s ShippingDetails object.
Possible values:
- SECOND_DAY
- NEXT_DAY
- EXPRESS
- STANDARD