amazonka-docdb-elastic-2.0: Amazon DocumentDB Elastic Clusters SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DocDbElastic.Lens

Description

 
Synopsis

Operations

CreateCluster

createCluster_clientToken :: Lens' CreateCluster (Maybe Text) Source #

The client token for the Elastic DocumentDB cluster.

createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text) Source #

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_preferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text) Source #

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_subnetIds :: Lens' CreateCluster (Maybe [Text]) Source #

The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.

createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text)) Source #

The tags to be assigned to the new Elastic DocumentDB cluster.

createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

createCluster_adminUserName :: Lens' CreateCluster Text Source #

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.

createCluster_adminUserPassword :: Lens' CreateCluster Text Source #

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_authType :: Lens' CreateCluster Auth Source #

The authentication type for the Elastic DocumentDB cluster.

createCluster_clusterName :: Lens' CreateCluster Text Source #

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_shardCapacity :: Lens' CreateCluster Int Source #

The capacity of each shard in the new Elastic DocumentDB cluster.

createCluster_shardCount :: Lens' CreateCluster Int Source #

The number of shards to create in the new Elastic DocumentDB cluster.

createClusterResponse_cluster :: Lens' CreateClusterResponse Cluster Source #

The new Elastic DocumentDB cluster that has been created.

CreateClusterSnapshot

createClusterSnapshot_tags :: Lens' CreateClusterSnapshot (Maybe (HashMap Text Text)) Source #

The tags to be assigned to the new Elastic DocumentDB snapshot.

createClusterSnapshot_clusterArn :: Lens' CreateClusterSnapshot Text Source #

The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.

createClusterSnapshot_snapshotName :: Lens' CreateClusterSnapshot Text Source #

The name of the Elastic DocumentDB snapshot.

createClusterSnapshotResponse_snapshot :: Lens' CreateClusterSnapshotResponse ClusterSnapshot Source #

Returns information about the new Elastic DocumentDB snapshot.

DeleteCluster

deleteCluster_clusterArn :: Lens' DeleteCluster Text Source #

The arn of the Elastic DocumentDB cluster that is to be deleted.

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse Cluster Source #

Returns information about the newly deleted Elastic DocumentDB cluster.

DeleteClusterSnapshot

deleteClusterSnapshot_snapshotArn :: Lens' DeleteClusterSnapshot Text Source #

The arn of the Elastic DocumentDB snapshot that is to be deleted.

deleteClusterSnapshotResponse_snapshot :: Lens' DeleteClusterSnapshotResponse ClusterSnapshot Source #

Returns information about the newly deleted Elastic DocumentDB snapshot.

GetCluster

getCluster_clusterArn :: Lens' GetCluster Text Source #

The arn of the Elastic DocumentDB cluster.

getClusterResponse_cluster :: Lens' GetClusterResponse Cluster Source #

Returns information about a specific Elastic DocumentDB cluster.

GetClusterSnapshot

getClusterSnapshot_snapshotArn :: Lens' GetClusterSnapshot Text Source #

The arn of the Elastic DocumentDB snapshot.

getClusterSnapshotResponse_snapshot :: Lens' GetClusterSnapshotResponse ClusterSnapshot Source #

Returns information about a specific Elastic DocumentDB snapshot.

ListClusterSnapshots

listClusterSnapshots_clusterArn :: Lens' ListClusterSnapshots (Maybe Text) Source #

The arn of the Elastic DocumentDB cluster.

listClusterSnapshots_maxResults :: Lens' ListClusterSnapshots (Maybe Natural) Source #

The maximum number of entries to recieve in the response.

listClusterSnapshots_nextToken :: Lens' ListClusterSnapshots (Maybe Text) Source #

The nextToken which is used the get the next page of data.

listClusterSnapshotsResponse_nextToken :: Lens' ListClusterSnapshotsResponse (Maybe Text) Source #

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.

listClusterSnapshotsResponse_snapshots :: Lens' ListClusterSnapshotsResponse (Maybe [ClusterSnapshotInList]) Source #

A list of Elastic DocumentDB snapshots for a specified cluster.

ListClusters

listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #

The maximum number of entries to recieve in the response.

listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #

The nextToken which is used the get the next page of data.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

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.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The arn of the Elastic DocumentDB resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The list of tags for the specified Elastic DocumentDB resource.

RestoreClusterFromSnapshot

restoreClusterFromSnapshot_kmsKeyId :: Lens' RestoreClusterFromSnapshot (Maybe Text) Source #

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_subnetIds :: Lens' RestoreClusterFromSnapshot (Maybe [Text]) Source #

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

restoreClusterFromSnapshot_tags :: Lens' RestoreClusterFromSnapshot (Maybe (HashMap Text Text)) Source #

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_vpcSecurityGroupIds :: Lens' RestoreClusterFromSnapshot (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.

restoreClusterFromSnapshotResponse_cluster :: Lens' RestoreClusterFromSnapshotResponse Cluster Source #

Returns information about a the restored Elastic DocumentDB cluster.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The arn of the Elastic DocumentDB resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to be assigned to the Elastic DocumentDB resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The arn of the Elastic DocumentDB resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys to be removed from the Elastic DocumentDB resource.

UpdateCluster

updateCluster_adminUserPassword :: Lens' UpdateCluster (Maybe Text) Source #

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_authType :: Lens' UpdateCluster (Maybe Auth) Source #

The authentication type for the Elastic DocumentDB cluster.

updateCluster_clientToken :: Lens' UpdateCluster (Maybe Text) Source #

The client token for the Elastic DocumentDB cluster.

updateCluster_preferredMaintenanceWindow :: Lens' UpdateCluster (Maybe Text) Source #

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_shardCapacity :: Lens' UpdateCluster (Maybe Int) Source #

The capacity of each shard in the Elastic DocumentDB cluster.

updateCluster_shardCount :: Lens' UpdateCluster (Maybe Int) Source #

The number of shards to create in the Elastic DocumentDB cluster.

updateCluster_subnetIds :: Lens' UpdateCluster (Maybe [Text]) Source #

The number of shards to create in the Elastic DocumentDB cluster.

updateCluster_vpcSecurityGroupIds :: Lens' UpdateCluster (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

updateCluster_clusterArn :: Lens' UpdateCluster Text Source #

The arn of the Elastic DocumentDB cluster.

updateClusterResponse_cluster :: Lens' UpdateClusterResponse Cluster Source #

Returns information about the updated Elastic DocumentDB cluster.

Types

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_clusterArn :: Lens' Cluster Text Source #

The arn of the Elastic DocumentDB cluster.

cluster_clusterEndpoint :: Lens' Cluster Text Source #

The URL used to connect to the Elastic DocumentDB cluster.

cluster_clusterName :: Lens' Cluster Text Source #

The name of 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_status :: Lens' Cluster Status Source #

The status of 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

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

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

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.