Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
While a cluster's ClusterState
value is in the AwaitingQuorum
state, you can update some of the information associated with a cluster.
Once the cluster changes to a different job state, usually 60 minutes
after the cluster being created, this action is no longer available.
Synopsis
- data UpdateCluster = UpdateCluster' {}
- newUpdateCluster :: Text -> UpdateCluster
- updateCluster_addressId :: Lens' UpdateCluster (Maybe Text)
- updateCluster_description :: Lens' UpdateCluster (Maybe Text)
- updateCluster_forwardingAddressId :: Lens' UpdateCluster (Maybe Text)
- updateCluster_notification :: Lens' UpdateCluster (Maybe Notification)
- updateCluster_onDeviceServiceConfiguration :: Lens' UpdateCluster (Maybe OnDeviceServiceConfiguration)
- updateCluster_resources :: Lens' UpdateCluster (Maybe JobResource)
- updateCluster_roleARN :: Lens' UpdateCluster (Maybe Text)
- updateCluster_shippingOption :: Lens' UpdateCluster (Maybe ShippingOption)
- updateCluster_clusterId :: Lens' UpdateCluster Text
- data UpdateClusterResponse = UpdateClusterResponse' {
- httpStatus :: Int
- newUpdateClusterResponse :: Int -> UpdateClusterResponse
- updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int
Creating a Request
data UpdateCluster Source #
See: newUpdateCluster
smart constructor.
UpdateCluster' | |
|
Instances
Create a value of UpdateCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCluster
, updateCluster_addressId
- The ID of the updated Address object.
UpdateCluster
, updateCluster_description
- The updated description of this cluster.
UpdateCluster
, updateCluster_forwardingAddressId
- The updated ID for the forwarding address for a cluster. This field is
not supported in most regions.
UpdateCluster
, updateCluster_notification
- The new or updated Notification object.
UpdateCluster
, updateCluster_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).
UpdateCluster
, updateCluster_resources
- The updated arrays of JobResource objects that can include updated
S3Resource objects or LambdaResource objects.
UpdateCluster
, updateCluster_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).
UpdateCluster
, updateCluster_shippingOption
- The updated shipping option value of this cluster's ShippingDetails
object.
UpdateCluster
, updateCluster_clusterId
- The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
.
Request Lenses
updateCluster_addressId :: Lens' UpdateCluster (Maybe Text) Source #
The ID of the updated Address object.
updateCluster_description :: Lens' UpdateCluster (Maybe Text) Source #
The updated description of this cluster.
updateCluster_forwardingAddressId :: Lens' UpdateCluster (Maybe Text) Source #
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
updateCluster_notification :: Lens' UpdateCluster (Maybe Notification) Source #
The new or updated Notification object.
updateCluster_onDeviceServiceConfiguration :: Lens' UpdateCluster (Maybe OnDeviceServiceConfiguration) Source #
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).
updateCluster_resources :: Lens' UpdateCluster (Maybe JobResource) Source #
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
updateCluster_roleARN :: Lens' UpdateCluster (Maybe Text) Source #
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).
updateCluster_shippingOption :: Lens' UpdateCluster (Maybe ShippingOption) Source #
The updated shipping option value of this cluster's ShippingDetails object.
updateCluster_clusterId :: Lens' UpdateCluster Text Source #
The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
.
Destructuring the Response
data UpdateClusterResponse Source #
See: newUpdateClusterResponse
smart constructor.
UpdateClusterResponse' | |
|
Instances
newUpdateClusterResponse Source #
Create a value of UpdateClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateClusterResponse'
, updateClusterResponse_httpStatus
- The response's http status code.
Response Lenses
updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int Source #
The response's http status code.