Skip to content

UpdateClusterRequest

Source code in docs_src/capo_snowball/types/update_cluster_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class UpdateClusterRequest(TypedDict, closed=True):
    cluster_id: "capo_snowball.types.cluster_id.ClusterId"
    """<p>The cluster ID of the cluster that you want to update, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>"""
    role_arn: NotRequired["capo_snowball.types.role_arn.RoleARN"]
    """<p>The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>"""
    description: NotRequired["capo_snowball.types.string.String"]
    """<p>The updated description of this cluster.</p>"""
    resources: NotRequired["capo_snowball.types.job_resource.JobResource"]
    """<p>The updated arrays of <a>JobResource</a> objects that can include updated <a>S3Resource</a> objects or <a>LambdaResource</a> objects.</p>"""
    on_device_service_configuration: NotRequired[
        "capo_snowball.types.on_device_service_configuration.OnDeviceServiceConfiguration"
    ]
    """<p>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).</p>"""
    address_id: NotRequired["capo_snowball.types.address_id.AddressId"]
    """<p>The ID of the updated <a>Address</a> object.</p>"""
    shipping_option: NotRequired["capo_snowball.types.shipping_option.ShippingOption"]
    """<p>The updated shipping option value of this cluster's <a>ShippingDetails</a> object.</p>"""
    notification: NotRequired["capo_snowball.types.notification.Notification"]
    """<p>The new or updated <a>Notification</a> object.</p>"""
    forwarding_address_id: NotRequired["capo_snowball.types.address_id.AddressId"]
    """<p>The updated ID for the forwarding address for a cluster. This field is not supported in most regions.</p>"""

address_id instance-attribute 

address_id: NotRequired[AddressId]

The ID of the updated Address object.

cluster_id instance-attribute 

cluster_id: ClusterId

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

description instance-attribute 

description: NotRequired[String]

The updated description of this cluster.

forwarding_address_id instance-attribute 

forwarding_address_id: NotRequired[AddressId]

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

notification instance-attribute 

notification: NotRequired[Notification]

The new or updated Notification object.

on_device_service_configuration instance-attribute 

on_device_service_configuration: NotRequired[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).

resources instance-attribute 

resources: NotRequired[JobResource]

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

role_arn instance-attribute 

role_arn: NotRequired[RoleARN]

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

shipping_option instance-attribute 

shipping_option: NotRequired[ShippingOption]

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