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 |
Derived from API version 2022-11-28
of the AWS service descriptions, licensed under Apache 2.0.
The new Amazon Elastic DocumentDB service endpoint.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateCluster = CreateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [Text]) Text (Sensitive Text) Auth Text Int Int
- newCreateCluster :: Text -> Text -> Auth -> Text -> Int -> Int -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' Int Cluster
- newCreateClusterResponse :: Int -> Cluster -> CreateClusterResponse
- data CreateClusterSnapshot = CreateClusterSnapshot' (Maybe (HashMap Text Text)) Text Text
- newCreateClusterSnapshot :: Text -> Text -> CreateClusterSnapshot
- data CreateClusterSnapshotResponse = CreateClusterSnapshotResponse' Int ClusterSnapshot
- newCreateClusterSnapshotResponse :: Int -> ClusterSnapshot -> CreateClusterSnapshotResponse
- data DeleteCluster = DeleteCluster' Text
- newDeleteCluster :: Text -> DeleteCluster
- data DeleteClusterResponse = DeleteClusterResponse' Int Cluster
- newDeleteClusterResponse :: Int -> Cluster -> DeleteClusterResponse
- data DeleteClusterSnapshot = DeleteClusterSnapshot' Text
- newDeleteClusterSnapshot :: Text -> DeleteClusterSnapshot
- data DeleteClusterSnapshotResponse = DeleteClusterSnapshotResponse' Int ClusterSnapshot
- newDeleteClusterSnapshotResponse :: Int -> ClusterSnapshot -> DeleteClusterSnapshotResponse
- data GetCluster = GetCluster' Text
- newGetCluster :: Text -> GetCluster
- data GetClusterResponse = GetClusterResponse' Int Cluster
- newGetClusterResponse :: Int -> Cluster -> GetClusterResponse
- data GetClusterSnapshot = GetClusterSnapshot' Text
- newGetClusterSnapshot :: Text -> GetClusterSnapshot
- data GetClusterSnapshotResponse = GetClusterSnapshotResponse' Int ClusterSnapshot
- newGetClusterSnapshotResponse :: Int -> ClusterSnapshot -> GetClusterSnapshotResponse
- data ListClusterSnapshots = ListClusterSnapshots' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListClusterSnapshots :: ListClusterSnapshots
- data ListClusterSnapshotsResponse = ListClusterSnapshotsResponse' (Maybe Text) (Maybe [ClusterSnapshotInList]) Int
- newListClusterSnapshotsResponse :: Int -> ListClusterSnapshotsResponse
- data ListClusters = ListClusters' (Maybe Natural) (Maybe Text)
- newListClusters :: ListClusters
- data ListClustersResponse = ListClustersResponse' (Maybe [ClusterInList]) (Maybe Text) Int
- newListClustersResponse :: Int -> ListClustersResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RestoreClusterFromSnapshot = RestoreClusterFromSnapshot' (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [Text]) Text Text
- newRestoreClusterFromSnapshot :: Text -> Text -> RestoreClusterFromSnapshot
- data RestoreClusterFromSnapshotResponse = RestoreClusterFromSnapshotResponse' Int Cluster
- newRestoreClusterFromSnapshotResponse :: Int -> Cluster -> RestoreClusterFromSnapshotResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateCluster = UpdateCluster' (Maybe (Sensitive Text)) (Maybe Auth) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe [Text]) Text
- newUpdateCluster :: Text -> UpdateCluster
- data UpdateClusterResponse = UpdateClusterResponse' Int Cluster
- newUpdateClusterResponse :: Int -> Cluster -> UpdateClusterResponse
- newtype Auth where
- Auth' { }
- pattern Auth_PLAIN_TEXT :: Auth
- pattern Auth_SECRET_ARN :: Auth
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_ACTIVE :: Status
- pattern Status_CREATING :: Status
- pattern Status_DELETING :: Status
- pattern Status_INACCESSIBLE_ENCRYPTION_CREDS :: Status
- pattern Status_INVALID_SECURITY_GROUP_ID :: Status
- pattern Status_INVALID_SUBNET_ID :: Status
- pattern Status_IP_ADDRESS_LIMIT_EXCEEDED :: Status
- pattern Status_UPDATING :: Status
- pattern Status_VPC_ENDPOINT_LIMIT_EXCEEDED :: Status
- Status' {
- data Cluster = Cluster' Text Auth Text Text Text Text Text Text Int Int Status [Text] [Text]
- newCluster :: Text -> Auth -> Text -> Text -> Text -> Text -> Text -> Text -> Int -> Int -> Status -> Cluster
- data ClusterInList = ClusterInList' Text Text Status
- newClusterInList :: Text -> Text -> Status -> ClusterInList
- data ClusterSnapshot = ClusterSnapshot' Text Text Text Text Text Text Text Status [Text] [Text]
- newClusterSnapshot :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> Status -> ClusterSnapshot
- data ClusterSnapshotInList = ClusterSnapshotInList' Text Text Text Text Status
- newClusterSnapshotInList :: Text -> Text -> Text -> Text -> Status -> ClusterSnapshotInList
Service Configuration
defaultService :: Service Source #
API version 2022-11-28
of the Amazon DocumentDB Elastic Clusters SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DocDbElastic
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
An exception that occurs when there are not sufficient permissions to perform an action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
There was an access conflict.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal server error.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource could not be located.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service quota for the action was exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
ThrottlingException will be thrown when request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
A structure defining a validation exception.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCluster
data CreateCluster Source #
See: newCreateCluster
smart constructor.
CreateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [Text]) Text (Sensitive Text) Auth Text Int Int |
Instances
Create a value of CreateCluster
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:clientToken:CreateCluster'
, createCluster_clientToken
- The client token for the Elastic DocumentDB cluster.
CreateCluster
, createCluster_kmsKeyId
- The KMS key identifier to use to encrypt the new Elastic DocumentDB
cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
CreateCluster
, createCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
CreateCluster
, createCluster_subnetIds
- The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
$sel:tags:CreateCluster'
, createCluster_tags
- The tags to be assigned to the new Elastic DocumentDB cluster.
CreateCluster
, createCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new Elastic
DocumentDB cluster.
CreateCluster
, createCluster_adminUserName
- The name of the Elastic DocumentDB cluster administrator.
Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word.
$sel:adminUserPassword:CreateCluster'
, createCluster_adminUserPassword
- The password for the Elastic DocumentDB cluster administrator and can
contain any printable ASCII characters.
Constraints:
- Must contain from 8 to 100 characters.
- Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
CreateCluster
, createCluster_authType
- The authentication type for the Elastic DocumentDB cluster.
CreateCluster
, createCluster_clusterName
- The name of the new Elastic DocumentDB cluster. This parameter is stored
as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
CreateCluster
, createCluster_shardCapacity
- The capacity of each shard in the new Elastic DocumentDB cluster.
CreateCluster
, createCluster_shardCount
- The number of shards to create in the new Elastic DocumentDB cluster.
data CreateClusterResponse Source #
See: newCreateClusterResponse
smart constructor.
Instances
newCreateClusterResponse Source #
:: Int | |
-> Cluster | |
-> CreateClusterResponse |
Create a value of CreateClusterResponse
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:CreateClusterResponse'
, createClusterResponse_httpStatus
- The response's http status code.
$sel:cluster:CreateClusterResponse'
, createClusterResponse_cluster
- The new Elastic DocumentDB cluster that has been created.
CreateClusterSnapshot
data CreateClusterSnapshot Source #
See: newCreateClusterSnapshot
smart constructor.
Instances
newCreateClusterSnapshot Source #
Create a value of CreateClusterSnapshot
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:tags:CreateClusterSnapshot'
, createClusterSnapshot_tags
- The tags to be assigned to the new Elastic DocumentDB snapshot.
CreateClusterSnapshot
, createClusterSnapshot_clusterArn
- The arn of the Elastic DocumentDB cluster that the snapshot will be
taken from.
CreateClusterSnapshot
, createClusterSnapshot_snapshotName
- The name of the Elastic DocumentDB snapshot.
data CreateClusterSnapshotResponse Source #
See: newCreateClusterSnapshotResponse
smart constructor.
Instances
newCreateClusterSnapshotResponse Source #
Create a value of CreateClusterSnapshotResponse
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:CreateClusterSnapshotResponse'
, createClusterSnapshotResponse_httpStatus
- The response's http status code.
$sel:snapshot:CreateClusterSnapshotResponse'
, createClusterSnapshotResponse_snapshot
- Returns information about the new Elastic DocumentDB snapshot.
DeleteCluster
data DeleteCluster Source #
See: newDeleteCluster
smart constructor.
Instances
Create a value of DeleteCluster
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:
DeleteCluster
, deleteCluster_clusterArn
- The arn of the Elastic DocumentDB cluster that is to be deleted.
data DeleteClusterResponse Source #
See: newDeleteClusterResponse
smart constructor.
Instances
newDeleteClusterResponse Source #
:: Int | |
-> Cluster | |
-> DeleteClusterResponse |
Create a value of DeleteClusterResponse
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:DeleteClusterResponse'
, deleteClusterResponse_httpStatus
- The response's http status code.
$sel:cluster:DeleteClusterResponse'
, deleteClusterResponse_cluster
- Returns information about the newly deleted Elastic DocumentDB cluster.
DeleteClusterSnapshot
data DeleteClusterSnapshot Source #
See: newDeleteClusterSnapshot
smart constructor.
Instances
newDeleteClusterSnapshot Source #
Create a value of DeleteClusterSnapshot
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:
DeleteClusterSnapshot
, deleteClusterSnapshot_snapshotArn
- The arn of the Elastic DocumentDB snapshot that is to be deleted.
data DeleteClusterSnapshotResponse Source #
See: newDeleteClusterSnapshotResponse
smart constructor.
Instances
newDeleteClusterSnapshotResponse Source #
Create a value of DeleteClusterSnapshotResponse
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:DeleteClusterSnapshotResponse'
, deleteClusterSnapshotResponse_httpStatus
- The response's http status code.
$sel:snapshot:DeleteClusterSnapshotResponse'
, deleteClusterSnapshotResponse_snapshot
- Returns information about the newly deleted Elastic DocumentDB snapshot.
GetCluster
data GetCluster Source #
See: newGetCluster
smart constructor.
Instances
:: Text | |
-> GetCluster |
Create a value of GetCluster
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:
GetCluster
, getCluster_clusterArn
- The arn of the Elastic DocumentDB cluster.
data GetClusterResponse Source #
See: newGetClusterResponse
smart constructor.
Instances
newGetClusterResponse Source #
:: Int | |
-> Cluster | |
-> GetClusterResponse |
Create a value of GetClusterResponse
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:GetClusterResponse'
, getClusterResponse_httpStatus
- The response's http status code.
$sel:cluster:GetClusterResponse'
, getClusterResponse_cluster
- Returns information about a specific Elastic DocumentDB cluster.
GetClusterSnapshot
data GetClusterSnapshot Source #
See: newGetClusterSnapshot
smart constructor.
Instances
newGetClusterSnapshot Source #
Create a value of GetClusterSnapshot
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:
GetClusterSnapshot
, getClusterSnapshot_snapshotArn
- The arn of the Elastic DocumentDB snapshot.
data GetClusterSnapshotResponse Source #
See: newGetClusterSnapshotResponse
smart constructor.
Instances
newGetClusterSnapshotResponse Source #
Create a value of GetClusterSnapshotResponse
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:GetClusterSnapshotResponse'
, getClusterSnapshotResponse_httpStatus
- The response's http status code.
$sel:snapshot:GetClusterSnapshotResponse'
, getClusterSnapshotResponse_snapshot
- Returns information about a specific Elastic DocumentDB snapshot.
ListClusterSnapshots (Paginated)
data ListClusterSnapshots Source #
See: newListClusterSnapshots
smart constructor.
Instances
newListClusterSnapshots :: ListClusterSnapshots Source #
Create a value of ListClusterSnapshots
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:
ListClusterSnapshots
, listClusterSnapshots_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:maxResults:ListClusterSnapshots'
, listClusterSnapshots_maxResults
- The maximum number of entries to recieve in the response.
ListClusterSnapshots
, listClusterSnapshots_nextToken
- The nextToken which is used the get the next page of data.
data ListClusterSnapshotsResponse Source #
See: newListClusterSnapshotsResponse
smart constructor.
Instances
newListClusterSnapshotsResponse Source #
Create a value of ListClusterSnapshotsResponse
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:
ListClusterSnapshots
, listClusterSnapshotsResponse_nextToken
- The response will provide a nextToken if there is more data beyond the
maxResults.
If there is no more data in the responce, the nextToken will not be returned.
$sel:snapshots:ListClusterSnapshotsResponse'
, listClusterSnapshotsResponse_snapshots
- A list of Elastic DocumentDB snapshots for a specified cluster.
$sel:httpStatus:ListClusterSnapshotsResponse'
, listClusterSnapshotsResponse_httpStatus
- The response's http status code.
ListClusters (Paginated)
data ListClusters Source #
See: newListClusters
smart constructor.
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters
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:maxResults:ListClusters'
, listClusters_maxResults
- The maximum number of entries to recieve in the response.
ListClusters
, listClusters_nextToken
- The nextToken which is used the get the next page of data.
data ListClustersResponse Source #
See: newListClustersResponse
smart constructor.
Instances
newListClustersResponse Source #
Create a value of ListClustersResponse
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:clusters:ListClustersResponse'
, listClustersResponse_clusters
- A list of Elastic DocumentDB cluster.
ListClusters
, listClustersResponse_nextToken
- The response will provide a nextToken if there is more data beyond the
maxResults.
If there is no more data in the responce, the nextToken will not be returned.
$sel:httpStatus:ListClustersResponse'
, listClustersResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The arn of the Elastic DocumentDB resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tags for the specified Elastic DocumentDB resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
RestoreClusterFromSnapshot
data RestoreClusterFromSnapshot Source #
See: newRestoreClusterFromSnapshot
smart constructor.
RestoreClusterFromSnapshot' (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [Text]) Text Text |
Instances
newRestoreClusterFromSnapshot Source #
Create a value of RestoreClusterFromSnapshot
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:
RestoreClusterFromSnapshot
, restoreClusterFromSnapshot_kmsKeyId
- The KMS key identifier to use to encrypt the new Elastic DocumentDB
cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
RestoreClusterFromSnapshot
, restoreClusterFromSnapshot_subnetIds
- The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
$sel:tags:RestoreClusterFromSnapshot'
, restoreClusterFromSnapshot_tags
- A list of the tag names to be assigned to the restored DB cluster, in
the form of an array of key-value pairs in which the key is the tag name
and the value is the key value.
RestoreClusterFromSnapshot
, restoreClusterFromSnapshot_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the Elastic
DocumentDB cluster.
RestoreClusterFromSnapshot
, restoreClusterFromSnapshot_clusterName
- The name of the Elastic DocumentDB cluster.
RestoreClusterFromSnapshot
, restoreClusterFromSnapshot_snapshotArn
- The arn of the Elastic DocumentDB snapshot.
data RestoreClusterFromSnapshotResponse Source #
See: newRestoreClusterFromSnapshotResponse
smart constructor.
Instances
Generic RestoreClusterFromSnapshotResponse Source # | |
Read RestoreClusterFromSnapshotResponse Source # | |
Show RestoreClusterFromSnapshotResponse Source # | |
NFData RestoreClusterFromSnapshotResponse Source # | |
Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot rnf :: RestoreClusterFromSnapshotResponse -> () # | |
Eq RestoreClusterFromSnapshotResponse Source # | |
type Rep RestoreClusterFromSnapshotResponse Source # | |
Defined in Amazonka.DocDbElastic.RestoreClusterFromSnapshot type Rep RestoreClusterFromSnapshotResponse = D1 ('MetaData "RestoreClusterFromSnapshotResponse" "Amazonka.DocDbElastic.RestoreClusterFromSnapshot" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "RestoreClusterFromSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Cluster))) |
newRestoreClusterFromSnapshotResponse Source #
Create a value of RestoreClusterFromSnapshotResponse
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:RestoreClusterFromSnapshotResponse'
, restoreClusterFromSnapshotResponse_httpStatus
- The response's http status code.
$sel:cluster:RestoreClusterFromSnapshotResponse'
, restoreClusterFromSnapshotResponse_cluster
- Returns information about a the restored Elastic DocumentDB cluster.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The arn of the Elastic DocumentDB resource.
$sel:tags:TagResource'
, tagResource_tags
- The tags to be assigned to the Elastic DocumentDB resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The arn of the Elastic DocumentDB resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys to be removed from the Elastic DocumentDB resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateCluster
data UpdateCluster Source #
See: newUpdateCluster
smart constructor.
UpdateCluster' (Maybe (Sensitive Text)) (Maybe Auth) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe [Text]) Text |
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:
$sel:adminUserPassword:UpdateCluster'
, updateCluster_adminUserPassword
- The password for the Elastic DocumentDB cluster administrator. This
password can contain any printable ASCII character except forward slash
(/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
UpdateCluster
, updateCluster_authType
- The authentication type for the Elastic DocumentDB cluster.
$sel:clientToken:UpdateCluster'
, updateCluster_clientToken
- The client token for the Elastic DocumentDB cluster.
UpdateCluster
, updateCluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
UpdateCluster
, updateCluster_shardCapacity
- The capacity of each shard in the Elastic DocumentDB cluster.
UpdateCluster
, updateCluster_shardCount
- The number of shards to create in the Elastic DocumentDB cluster.
UpdateCluster
, updateCluster_subnetIds
- The number of shards to create in the Elastic DocumentDB cluster.
UpdateCluster
, updateCluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new Elastic
DocumentDB cluster.
UpdateCluster
, updateCluster_clusterArn
- The arn of the Elastic DocumentDB cluster.
data UpdateClusterResponse Source #
See: newUpdateClusterResponse
smart constructor.
Instances
newUpdateClusterResponse Source #
:: Int | |
-> Cluster | |
-> UpdateClusterResponse |
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.
$sel:cluster:UpdateClusterResponse'
, updateClusterResponse_cluster
- Returns information about the updated Elastic DocumentDB cluster.
Types
Auth
pattern Auth_PLAIN_TEXT :: Auth | |
pattern Auth_SECRET_ARN :: Auth |
Instances
Status
pattern Status_ACTIVE :: Status | |
pattern Status_CREATING :: Status | |
pattern Status_DELETING :: Status | |
pattern Status_INACCESSIBLE_ENCRYPTION_CREDS :: Status | |
pattern Status_INVALID_SECURITY_GROUP_ID :: Status | |
pattern Status_INVALID_SUBNET_ID :: Status | |
pattern Status_IP_ADDRESS_LIMIT_EXCEEDED :: Status | |
pattern Status_UPDATING :: Status | |
pattern Status_VPC_ENDPOINT_LIMIT_EXCEEDED :: Status |
Instances
Cluster
Returns information about a specific Elastic DocumentDB cluster.
See: newCluster
smart constructor.
Instances
Create a value of Cluster
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:adminUserName:Cluster'
, cluster_adminUserName
- The name of the Elastic DocumentDB cluster administrator.
$sel:authType:Cluster'
, cluster_authType
- The authentication type for the Elastic DocumentDB cluster.
$sel:clusterArn:Cluster'
, cluster_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:clusterEndpoint:Cluster'
, cluster_clusterEndpoint
- The URL used to connect to the Elastic DocumentDB cluster.
$sel:clusterName:Cluster'
, cluster_clusterName
- The name of the Elastic DocumentDB cluster.
$sel:createTime:Cluster'
, cluster_createTime
- The time when the Elastic DocumentDB cluster was created in Universal
Coordinated Time (UTC).
$sel:kmsKeyId:Cluster'
, cluster_kmsKeyId
- The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
$sel:preferredMaintenanceWindow:Cluster'
, cluster_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
$sel:shardCapacity:Cluster'
, cluster_shardCapacity
- The capacity of each shard in the Elastic DocumentDB cluster.
$sel:shardCount:Cluster'
, cluster_shardCount
- The number of shards in the Elastic DocumentDB cluster.
$sel:status:Cluster'
, cluster_status
- The status of the Elastic DocumentDB cluster.
$sel:subnetIds:Cluster'
, cluster_subnetIds
- The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
$sel:vpcSecurityGroupIds:Cluster'
, cluster_vpcSecurityGroupIds
- A list of EC2 VPC security groups associated with this cluster.
ClusterInList
data ClusterInList Source #
A list of Elastic DocumentDB cluster.
See: newClusterInList
smart constructor.
Instances
:: Text | |
-> Text | |
-> Status | |
-> ClusterInList |
Create a value of ClusterInList
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:clusterArn:ClusterInList'
, clusterInList_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:clusterName:ClusterInList'
, clusterInList_clusterName
- The name of the Elastic DocumentDB cluster.
$sel:status:ClusterInList'
, clusterInList_status
- The status of the Elastic DocumentDB cluster.
ClusterSnapshot
data ClusterSnapshot Source #
Returns information about a specific Elastic DocumentDB snapshot.
See: newClusterSnapshot
smart constructor.
Instances
Create a value of ClusterSnapshot
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:adminUserName:ClusterSnapshot'
, clusterSnapshot_adminUserName
- The name of the Elastic DocumentDB cluster administrator.
$sel:clusterArn:ClusterSnapshot'
, clusterSnapshot_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:clusterCreationTime:ClusterSnapshot'
, clusterSnapshot_clusterCreationTime
- The time when the Elastic DocumentDB cluster was created in Universal
Coordinated Time (UTC).
$sel:kmsKeyId:ClusterSnapshot'
, clusterSnapshot_kmsKeyId
- The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
$sel:snapshotArn:ClusterSnapshot'
, clusterSnapshot_snapshotArn
- The arn of the Elastic DocumentDB snapshot
$sel:snapshotCreationTime:ClusterSnapshot'
, clusterSnapshot_snapshotCreationTime
- The time when the Elastic DocumentDB snapshot was created in Universal
Coordinated Time (UTC).
$sel:snapshotName:ClusterSnapshot'
, clusterSnapshot_snapshotName
- The name of the Elastic DocumentDB snapshot.
$sel:status:ClusterSnapshot'
, clusterSnapshot_status
- The status of the Elastic DocumentDB snapshot.
$sel:subnetIds:ClusterSnapshot'
, clusterSnapshot_subnetIds
- A list of the IDs of subnets associated with the DB cluster snapshot.
$sel:vpcSecurityGroupIds:ClusterSnapshot'
, clusterSnapshot_vpcSecurityGroupIds
- A list of the IDs of the VPC security groups associated with the cluster
snapshot.
ClusterSnapshotInList
data ClusterSnapshotInList Source #
A list of Elastic DocumentDB snapshots.
See: newClusterSnapshotInList
smart constructor.
Instances
newClusterSnapshotInList Source #
Create a value of ClusterSnapshotInList
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:clusterArn:ClusterSnapshotInList'
, clusterSnapshotInList_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:snapshotArn:ClusterSnapshotInList'
, clusterSnapshotInList_snapshotArn
- The arn of the Elastic DocumentDB snapshot
$sel:snapshotCreationTime:ClusterSnapshotInList'
, clusterSnapshotInList_snapshotCreationTime
- The time when the Elastic DocumentDB snapshot was created in Universal
Coordinated Time (UTC).
$sel:snapshotName:ClusterSnapshotInList'
, clusterSnapshotInList_snapshotName
- The name of the Elastic DocumentDB snapshot.
$sel:status:ClusterSnapshotInList'
, clusterSnapshotInList_status
- The status of the Elastic DocumentDB snapshot.