Docdb Elastic

This page documents function available when using the Docdb_Elastic module, created with @service Docdb_Elastic.

Index

Documentation

Main.Docdb_Elastic.create_clusterMethod
create_cluster(admin_user_name, admin_user_password, auth_type, cluster_name, shard_capacity, shard_count)
create_cluster(admin_user_name, admin_user_password, auth_type, cluster_name, shard_capacity, shard_count, params::Dict{String,<:Any})

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

Arguments

  • admin_user_name: 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.
  • admin_user_password: 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 (@).
  • auth_type: The authentication type for the Elastic DocumentDB cluster.
  • cluster_name: 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
  • shard_capacity: The capacity of each shard in the new Elastic DocumentDB cluster.
  • shard_count: The number of shards to create in the new Elastic DocumentDB cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The client token for the Elastic DocumentDB cluster.
  • "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.
  • "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.
  • "subnetIds": The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
  • "tags": The tags to be assigned to the new Elastic DocumentDB cluster.
  • "vpcSecurityGroupIds": A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
Main.Docdb_Elastic.create_cluster_snapshotMethod
create_cluster_snapshot(cluster_arn, snapshot_name)
create_cluster_snapshot(cluster_arn, snapshot_name, params::Dict{String,<:Any})

Creates a snapshot of a cluster.

Arguments

  • cluster_arn: The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.
  • snapshot_name: The name of the Elastic DocumentDB snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": The tags to be assigned to the new Elastic DocumentDB snapshot.
Main.Docdb_Elastic.delete_clusterMethod
delete_cluster(cluster_arn)
delete_cluster(cluster_arn, params::Dict{String,<:Any})

Delete a Elastic DocumentDB cluster.

Arguments

  • cluster_arn: The arn of the Elastic DocumentDB cluster that is to be deleted.
Main.Docdb_Elastic.delete_cluster_snapshotMethod
delete_cluster_snapshot(snapshot_arn)
delete_cluster_snapshot(snapshot_arn, params::Dict{String,<:Any})

Delete a Elastic DocumentDB snapshot.

Arguments

  • snapshot_arn: The arn of the Elastic DocumentDB snapshot that is to be deleted.
Main.Docdb_Elastic.get_clusterMethod
get_cluster(cluster_arn)
get_cluster(cluster_arn, params::Dict{String,<:Any})

Returns information about a specific Elastic DocumentDB cluster.

Arguments

  • cluster_arn: The arn of the Elastic DocumentDB cluster.
Main.Docdb_Elastic.get_cluster_snapshotMethod
get_cluster_snapshot(snapshot_arn)
get_cluster_snapshot(snapshot_arn, params::Dict{String,<:Any})

Returns information about a specific Elastic DocumentDB snapshot

Arguments

  • snapshot_arn: The arn of the Elastic DocumentDB snapshot.
Main.Docdb_Elastic.list_cluster_snapshotsMethod
list_cluster_snapshots()
list_cluster_snapshots(params::Dict{String,<:Any})

Returns information about Elastic DocumentDB snapshots for a specified cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clusterArn": The arn of the Elastic DocumentDB cluster.
  • "maxResults": The maximum number of entries to recieve in the response.
  • "nextToken": The nextToken which is used the get the next page of data.
Main.Docdb_Elastic.list_clustersMethod
list_clusters()
list_clusters(params::Dict{String,<:Any})

Returns information about provisioned Elastic DocumentDB clusters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of entries to recieve in the response.
  • "nextToken": The nextToken which is used the get the next page of data.
Main.Docdb_Elastic.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists all tags on a Elastic DocumentDB resource

Arguments

  • resource_arn: The arn of the Elastic DocumentDB resource.
Main.Docdb_Elastic.restore_cluster_from_snapshotMethod
restore_cluster_from_snapshot(cluster_name, snapshot_arn)
restore_cluster_from_snapshot(cluster_name, snapshot_arn, params::Dict{String,<:Any})

Restores a Elastic DocumentDB cluster from a snapshot.

Arguments

  • cluster_name: The name of the Elastic DocumentDB cluster.
  • snapshot_arn: The arn of the Elastic DocumentDB snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "subnetIds": The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
  • "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.
  • "vpcSecurityGroupIds": A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.
Main.Docdb_Elastic.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds metadata tags to a Elastic DocumentDB resource

Arguments

  • resource_arn: The arn of the Elastic DocumentDB resource.
  • tags: The tags to be assigned to the Elastic DocumentDB resource.
Main.Docdb_Elastic.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes metadata tags to a Elastic DocumentDB resource

Arguments

  • resource_arn: The arn of the Elastic DocumentDB resource.
  • tag_keys: The tag keys to be removed from the Elastic DocumentDB resource.
Main.Docdb_Elastic.update_clusterMethod
update_cluster(cluster_arn)
update_cluster(cluster_arn, params::Dict{String,<:Any})

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

Arguments

  • cluster_arn: The arn of the Elastic DocumentDB cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "authType": The authentication type for the Elastic DocumentDB cluster.
  • "clientToken": The client token for the Elastic DocumentDB cluster.
  • "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.
  • "shardCapacity": The capacity of each shard in the Elastic DocumentDB cluster.
  • "shardCount": The number of shards to create in the Elastic DocumentDB cluster.
  • "subnetIds": The number of shards to create in the Elastic DocumentDB cluster.
  • "vpcSecurityGroupIds": A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.