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 |
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
- 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' {
- adminUserName :: Text
- authType :: Auth
- clusterArn :: Text
- clusterEndpoint :: Text
- clusterName :: Text
- createTime :: Text
- kmsKeyId :: Text
- preferredMaintenanceWindow :: Text
- shardCapacity :: Int
- shardCount :: Int
- status :: Status
- subnetIds :: [Text]
- vpcSecurityGroupIds :: [Text]
- newCluster :: Text -> Auth -> Text -> Text -> Text -> Text -> Text -> Text -> Int -> Int -> Status -> Cluster
- cluster_adminUserName :: Lens' Cluster Text
- cluster_authType :: Lens' Cluster Auth
- cluster_clusterArn :: Lens' Cluster Text
- cluster_clusterEndpoint :: Lens' Cluster Text
- cluster_clusterName :: Lens' Cluster Text
- cluster_createTime :: Lens' Cluster Text
- cluster_kmsKeyId :: Lens' Cluster Text
- cluster_preferredMaintenanceWindow :: Lens' Cluster Text
- cluster_shardCapacity :: Lens' Cluster Int
- cluster_shardCount :: Lens' Cluster Int
- cluster_status :: Lens' Cluster Status
- cluster_subnetIds :: Lens' Cluster [Text]
- cluster_vpcSecurityGroupIds :: Lens' Cluster [Text]
- data ClusterInList = ClusterInList' {
- clusterArn :: Text
- clusterName :: Text
- status :: Status
- newClusterInList :: Text -> Text -> Status -> ClusterInList
- clusterInList_clusterArn :: Lens' ClusterInList Text
- clusterInList_clusterName :: Lens' ClusterInList Text
- clusterInList_status :: Lens' ClusterInList Status
- data ClusterSnapshot = ClusterSnapshot' {
- adminUserName :: Text
- clusterArn :: Text
- clusterCreationTime :: Text
- kmsKeyId :: Text
- snapshotArn :: Text
- snapshotCreationTime :: Text
- snapshotName :: Text
- status :: Status
- subnetIds :: [Text]
- vpcSecurityGroupIds :: [Text]
- newClusterSnapshot :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> Status -> ClusterSnapshot
- clusterSnapshot_adminUserName :: Lens' ClusterSnapshot Text
- clusterSnapshot_clusterArn :: Lens' ClusterSnapshot Text
- clusterSnapshot_clusterCreationTime :: Lens' ClusterSnapshot Text
- clusterSnapshot_kmsKeyId :: Lens' ClusterSnapshot Text
- clusterSnapshot_snapshotArn :: Lens' ClusterSnapshot Text
- clusterSnapshot_snapshotCreationTime :: Lens' ClusterSnapshot Text
- clusterSnapshot_snapshotName :: Lens' ClusterSnapshot Text
- clusterSnapshot_status :: Lens' ClusterSnapshot Status
- clusterSnapshot_subnetIds :: Lens' ClusterSnapshot [Text]
- clusterSnapshot_vpcSecurityGroupIds :: Lens' ClusterSnapshot [Text]
- data ClusterSnapshotInList = ClusterSnapshotInList' {}
- newClusterSnapshotInList :: Text -> Text -> Text -> Text -> Status -> ClusterSnapshotInList
- clusterSnapshotInList_clusterArn :: Lens' ClusterSnapshotInList Text
- clusterSnapshotInList_snapshotArn :: Lens' ClusterSnapshotInList Text
- clusterSnapshotInList_snapshotCreationTime :: Lens' ClusterSnapshotInList Text
- clusterSnapshotInList_snapshotName :: Lens' ClusterSnapshotInList Text
- clusterSnapshotInList_status :: Lens' ClusterSnapshotInList Status
Service Configuration
defaultService :: Service Source #
API version 2022-11-28
of the Amazon DocumentDB Elastic Clusters SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
An exception that occurs when there are not sufficient permissions to perform an action.
_ConflictException :: AsError a => Fold a ServiceError Source #
There was an access conflict.
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal server error.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource could not be located.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service quota for the action was exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
ThrottlingException will be thrown when request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
A structure defining a validation exception.
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.
Cluster' | |
|
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.
cluster_adminUserName :: Lens' Cluster Text Source #
The name of the Elastic DocumentDB cluster administrator.
cluster_authType :: Lens' Cluster Auth Source #
The authentication type for the Elastic DocumentDB cluster.
cluster_clusterEndpoint :: Lens' Cluster Text Source #
The URL used to connect to the Elastic DocumentDB cluster.
cluster_createTime :: Lens' Cluster Text Source #
The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
cluster_kmsKeyId :: Lens' Cluster Text Source #
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
cluster_preferredMaintenanceWindow :: Lens' Cluster Text Source #
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
cluster_shardCapacity :: Lens' Cluster Int Source #
The capacity of each shard in the Elastic DocumentDB cluster.
cluster_shardCount :: Lens' Cluster Int Source #
The number of shards in the Elastic DocumentDB cluster.
cluster_subnetIds :: Lens' Cluster [Text] Source #
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
cluster_vpcSecurityGroupIds :: Lens' Cluster [Text] Source #
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.
ClusterInList' | |
|
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.
clusterInList_clusterArn :: Lens' ClusterInList Text Source #
The arn of the Elastic DocumentDB cluster.
clusterInList_clusterName :: Lens' ClusterInList Text Source #
The name of the Elastic DocumentDB cluster.
clusterInList_status :: Lens' ClusterInList Status Source #
The status of the Elastic DocumentDB cluster.
ClusterSnapshot
data ClusterSnapshot Source #
Returns information about a specific Elastic DocumentDB snapshot.
See: newClusterSnapshot
smart constructor.
ClusterSnapshot' | |
|
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.
clusterSnapshot_adminUserName :: Lens' ClusterSnapshot Text Source #
The name of the Elastic DocumentDB cluster administrator.
clusterSnapshot_clusterArn :: Lens' ClusterSnapshot Text Source #
The arn of the Elastic DocumentDB cluster.
clusterSnapshot_clusterCreationTime :: Lens' ClusterSnapshot Text Source #
The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
clusterSnapshot_kmsKeyId :: Lens' ClusterSnapshot Text Source #
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
clusterSnapshot_snapshotArn :: Lens' ClusterSnapshot Text Source #
The arn of the Elastic DocumentDB snapshot
clusterSnapshot_snapshotCreationTime :: Lens' ClusterSnapshot Text Source #
The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
clusterSnapshot_snapshotName :: Lens' ClusterSnapshot Text Source #
The name of the Elastic DocumentDB snapshot.
clusterSnapshot_status :: Lens' ClusterSnapshot Status Source #
The status of the Elastic DocumentDB snapshot.
clusterSnapshot_subnetIds :: Lens' ClusterSnapshot [Text] Source #
A list of the IDs of subnets associated with the DB cluster snapshot.
clusterSnapshot_vpcSecurityGroupIds :: Lens' ClusterSnapshot [Text] Source #
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.
ClusterSnapshotInList' | |
|
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.
clusterSnapshotInList_clusterArn :: Lens' ClusterSnapshotInList Text Source #
The arn of the Elastic DocumentDB cluster.
clusterSnapshotInList_snapshotArn :: Lens' ClusterSnapshotInList Text Source #
The arn of the Elastic DocumentDB snapshot
clusterSnapshotInList_snapshotCreationTime :: Lens' ClusterSnapshotInList Text Source #
The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
clusterSnapshotInList_snapshotName :: Lens' ClusterSnapshotInList Text Source #
The name of the Elastic DocumentDB snapshot.
clusterSnapshotInList_status :: Lens' ClusterSnapshotInList Status Source #
The status of the Elastic DocumentDB snapshot.