Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
- updateCluster :: Text -> UpdateCluster
- data UpdateCluster
- ucNotification :: Lens' UpdateCluster (Maybe Notification)
- ucForwardingAddressId :: Lens' UpdateCluster (Maybe Text)
- ucAddressId :: Lens' UpdateCluster (Maybe Text)
- ucShippingOption :: Lens' UpdateCluster (Maybe ShippingOption)
- ucResources :: Lens' UpdateCluster (Maybe JobResource)
- ucDescription :: Lens' UpdateCluster (Maybe Text)
- ucRoleARN :: Lens' UpdateCluster (Maybe Text)
- ucClusterId :: Lens' UpdateCluster Text
- updateClusterResponse :: Int -> UpdateClusterResponse
- data UpdateClusterResponse
- ucrsResponseStatus :: Lens' UpdateClusterResponse Int
Creating a Request
Creates a value of UpdateCluster
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ucNotification
- The new or updatedNotification
object.ucForwardingAddressId
- The updated ID for the forwarding address for a cluster. This field is not supported in most regions.ucAddressId
- The ID of the updatedAddress
object.ucShippingOption
- The updated shipping option value of this cluster'sShippingDetails
object.ucResources
- The updated arrays ofJobResource
objects that can include updatedS3Resource
objects orLambdaResource
objects.ucDescription
- The updated description of this cluster.ucRoleARN
- 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).ucClusterId
- The cluster ID of the cluster that you want to update, for exampleCID123e4567-e89b-12d3-a456-426655440000
.
data UpdateCluster Source #
See: updateCluster
smart constructor.
Request Lenses
ucNotification :: Lens' UpdateCluster (Maybe Notification) Source #
The new or updated Notification
object.
ucForwardingAddressId :: Lens' UpdateCluster (Maybe Text) Source #
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
ucAddressId :: Lens' UpdateCluster (Maybe Text) Source #
The ID of the updated Address
object.
ucShippingOption :: Lens' UpdateCluster (Maybe ShippingOption) Source #
The updated shipping option value of this cluster's ShippingDetails
object.
ucResources :: Lens' UpdateCluster (Maybe JobResource) Source #
The updated arrays of JobResource
objects that can include updated S3Resource
objects or LambdaResource
objects.
ucDescription :: Lens' UpdateCluster (Maybe Text) Source #
The updated description of this cluster.
ucRoleARN :: 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 AWS Identity and Access Management (IAM).
ucClusterId :: 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
updateClusterResponse Source #
Creates a value of UpdateClusterResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ucrsResponseStatus
- -- | The response status code.
data UpdateClusterResponse Source #
See: updateClusterResponse
smart constructor.
Response Lenses
ucrsResponseStatus :: Lens' UpdateClusterResponse Int Source #
- - | The response status code.