Docdb

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

Index

Documentation

Main.Docdb.add_source_identifier_to_subscriptionMethod
add_source_identifier_to_subscription(source_identifier, subscription_name)
add_source_identifier_to_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})

Adds a source identifier to an existing event notification subscription.

Arguments

  • source_identifier: The identifier of the event source to be added: If the source type is an instance, a DBInstanceIdentifier must be provided. If the source type is a security group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a DBParameterGroupName must be provided. If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
  • subscription_name: The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.
Main.Docdb.add_tags_to_resourceMethod
add_tags_to_resource(resource_name, tag)
add_tags_to_resource(resource_name, tag, params::Dict{String,<:Any})

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

Arguments

  • resource_name: The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .
  • tag: The tags to be assigned to the Amazon DocumentDB resource.

Optional Parameters

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

  • "Tags": The tags to be assigned to the Amazon DocumentDB resource.
Main.Docdb.apply_pending_maintenance_actionMethod
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier)
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier, params::Dict{String,<:Any})

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Arguments

  • apply_action: The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade
  • opt_in_type: A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests.
  • resource_identifier: The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
Main.Docdb.copy_dbcluster_parameter_groupMethod
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier)
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier, params::Dict{String,<:Any})

Copies the specified cluster parameter group.

Arguments

  • source_dbcluster_parameter_group_identifier: The identifier or Amazon Resource Name (ARN) for the source cluster parameter group. Constraints: Must specify a valid cluster parameter group. If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN. If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
  • target_dbcluster_parameter_group_description: A description for the copied cluster parameter group.
  • target_dbcluster_parameter_group_identifier: The identifier for the copied cluster parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-param-group1

Optional Parameters

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

  • "Tags": The tags that are to be assigned to the parameter group.
Main.Docdb.copy_dbcluster_snapshotMethod
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier)
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier, params::Dict{String,<:Any})

Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

Arguments

  • source_dbcluster_snapshot_identifier: The identifier of the cluster snapshot to copy. This parameter is not case sensitive. Constraints: Must specify a valid system snapshot in the available state. If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier. If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN. Example: my-cluster-snapshot1
  • target_dbcluster_snapshot_identifier: The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive. 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-snapshot2

Optional Parameters

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

  • "CopyTags": Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
  • "KmsKeyId": The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot. If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId. To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region. If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
  • "PreSignedUrl": The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values: SourceRegion - The ID of the region that contains the snapshot to be copied. SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot. TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
  • "Tags": The tags to be assigned to the cluster snapshot.
Main.Docdb.create_dbclusterMethod
create_dbcluster(dbcluster_identifier, engine)
create_dbcluster(dbcluster_identifier, engine, params::Dict{String,<:Any})

Creates a new Amazon DocumentDB cluster.

Arguments

  • dbcluster_identifier: The cluster identifier. 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
  • engine: The name of the database engine to be used for this cluster. Valid values: docdb

Optional Parameters

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

  • "AvailabilityZones": A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  • "BackupRetentionPeriod": The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to
  • "DBClusterParameterGroupName": The name of the cluster parameter group to associate with this cluster.
  • "DBSubnetGroupName": A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
  • "DeletionProtection": Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  • "EnableCloudwatchLogsExports": A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
  • "EngineVersion": The version number of the database engine to use. The –engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
  • "GlobalClusterIdentifier": The cluster identifier of the new global cluster.
  • "KmsKeyId": The KMS key identifier for an encrypted 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 Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in KmsKeyId: If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
  • "MasterUserPassword": The password for the master database user. 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.
  • "MasterUsername": The name of the master user for the cluster. Constraints: Must be from 1 to 63 letters or numbers. The first character must be a letter. Cannot be a reserved word for the chosen database engine.
  • "Port": The port number on which the instances in the cluster accept connections.
  • "PreSignedUrl": Not currently supported.
  • "PreferredBackupWindow": The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
  • "PreferredMaintenanceWindow": The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is 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.
  • "StorageEncrypted": Specifies whether the cluster is encrypted.
  • "Tags": The tags to be assigned to the cluster.
  • "VpcSecurityGroupIds": A list of EC2 VPC security groups to associate with this cluster.
Main.Docdb.create_dbcluster_parameter_groupMethod
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description)
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description, params::Dict{String,<:Any})

Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

Arguments

  • dbcluster_parameter_group_name: The name of the cluster parameter group. Constraints: Must not match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string.
  • dbparameter_group_family: The cluster parameter group family name.
  • description: The description for the cluster parameter group.

Optional Parameters

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

  • "Tags": The tags to be assigned to the cluster parameter group.
Main.Docdb.create_dbcluster_snapshotMethod
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier)
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier, params::Dict{String,<:Any})

Creates a snapshot of a cluster.

Arguments

  • dbcluster_identifier: The identifier of the cluster to create a snapshot for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster
  • dbcluster_snapshot_identifier: The identifier of the cluster snapshot. 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-snapshot1

Optional Parameters

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

  • "Tags": The tags to be assigned to the cluster snapshot.
Main.Docdb.create_dbinstanceMethod
create_dbinstance(dbcluster_identifier, dbinstance_class, dbinstance_identifier, engine)
create_dbinstance(dbcluster_identifier, dbinstance_class, dbinstance_identifier, engine, params::Dict{String,<:Any})

Creates a new instance.

Arguments

  • dbcluster_identifier: The identifier of the cluster that the instance will belong to.
  • dbinstance_class: The compute and memory capacity of the instance; for example, db.r5.large.
  • dbinstance_identifier: The instance identifier. 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: mydbinstance
  • engine: The name of the database engine to be used for this instance. Valid value: docdb

Optional Parameters

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

  • "AutoMinorVersionUpgrade": This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default: false
  • "AvailabilityZone": The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. Example: us-east-1d
  • "CopyTagsToSnapshot": A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
  • "EnablePerformanceInsights": A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
  • "PerformanceInsightsKMSKeyId": The KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
  • "PreferredMaintenanceWindow": The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is 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.
  • "PromotionTier": A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15
  • "Tags": The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
Main.Docdb.create_dbsubnet_groupMethod
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier)
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

Arguments

  • dbsubnet_group_description: The description for the subnet group.
  • dbsubnet_group_name: The name for the subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
  • subnet_identifier: The Amazon EC2 subnet IDs for the subnet group.

Optional Parameters

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

  • "SubnetIds": The Amazon EC2 subnet IDs for the subnet group.
  • "Tags": The tags to be assigned to the subnet group.
Main.Docdb.create_event_subscriptionMethod
create_event_subscription(sns_topic_arn, subscription_name)
create_event_subscription(sns_topic_arn, subscription_name, params::Dict{String,<:Any})

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

Arguments

  • sns_topic_arn: The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
  • subscription_name: The name of the subscription. Constraints: The name must be fewer than 255 characters.

Optional Parameters

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

  • "Enabled": A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  • "EventCategories": A list of event categories for a SourceType that you want to subscribe to.
  • "SourceIds": The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are provided, SourceType must also be provided. If the source type is an instance, a DBInstanceIdentifier must be provided. If the source type is a security group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a DBParameterGroupName must be provided. If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
  • "SourceType": The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned. Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
  • "Tags": The tags to be assigned to the event subscription.
Main.Docdb.create_global_clusterMethod
create_global_cluster(global_cluster_identifier)
create_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance. You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. This action only applies to Amazon DocumentDB clusters.

Arguments

  • global_cluster_identifier: The cluster identifier of the new global cluster.

Optional Parameters

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

  • "DatabaseName": The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.
  • "DeletionProtection": The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.
  • "Engine": The name of the database engine to be used for this cluster.
  • "EngineVersion": The engine version of the global cluster.
  • "SourceDBClusterIdentifier": The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.
  • "StorageEncrypted": The storage encryption setting for the new global cluster.
Main.Docdb.delete_dbclusterMethod
delete_dbcluster(dbcluster_identifier)
delete_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

Arguments

  • dbcluster_identifier: The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive. Constraints: Must match an existing DBClusterIdentifier.

Optional Parameters

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

  • "FinalDBSnapshotIdentifier": The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be from 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
  • "SkipFinalSnapshot": Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted. If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter. Default: false
Main.Docdb.delete_dbcluster_parameter_groupMethod
delete_dbcluster_parameter_group(dbcluster_parameter_group_name)
delete_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

Arguments

  • dbcluster_parameter_group_name: The name of the cluster parameter group. Constraints: Must be the name of an existing cluster parameter group. You can't delete a default cluster parameter group. Cannot be associated with any clusters.
Main.Docdb.delete_dbcluster_snapshotMethod
delete_dbcluster_snapshot(dbcluster_snapshot_identifier)
delete_dbcluster_snapshot(dbcluster_snapshot_identifier, params::Dict{String,<:Any})

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted.

Arguments

  • dbcluster_snapshot_identifier: The identifier of the cluster snapshot to delete. Constraints: Must be the name of an existing cluster snapshot in the available state.
Main.Docdb.delete_dbinstanceMethod
delete_dbinstance(dbinstance_identifier)
delete_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})

Deletes a previously provisioned instance.

Arguments

  • dbinstance_identifier: The instance identifier for the instance to be deleted. This parameter isn't case sensitive. Constraints: Must match the name of an existing instance.
Main.Docdb.delete_dbsubnet_groupMethod
delete_dbsubnet_group(dbsubnet_group_name)
delete_dbsubnet_group(dbsubnet_group_name, params::Dict{String,<:Any})

Deletes a subnet group. The specified database subnet group must not be associated with any DB instances.

Arguments

  • dbsubnet_group_name: The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
Main.Docdb.delete_event_subscriptionMethod
delete_event_subscription(subscription_name)
delete_event_subscription(subscription_name, params::Dict{String,<:Any})

Deletes an Amazon DocumentDB event notification subscription.

Arguments

  • subscription_name: The name of the Amazon DocumentDB event notification subscription that you want to delete.
Main.Docdb.delete_global_clusterMethod
delete_global_cluster(global_cluster_identifier)
delete_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action only applies to Amazon DocumentDB clusters.

Arguments

  • global_cluster_identifier: The cluster identifier of the global cluster being deleted.
Main.Docdb.describe_certificatesMethod
describe_certificates()
describe_certificates(params::Dict{String,<:Any})

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

Optional Parameters

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

  • "CertificateIdentifier": The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive. Constraints Must match an existing CertificateIdentifier.
  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum: 20 Maximum: 100
Main.Docdb.describe_dbcluster_parameter_groupsMethod
describe_dbcluster_parameter_groups()
describe_dbcluster_parameter_groups(params::Dict{String,<:Any})

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

Optional Parameters

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

  • "DBClusterParameterGroupName": The name of a specific cluster parameter group to return details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup.
  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_dbcluster_parametersMethod
describe_dbcluster_parameters(dbcluster_parameter_group_name)
describe_dbcluster_parameters(dbcluster_parameter_group_name, params::Dict{String,<:Any})

Returns the detailed parameter list for a particular cluster parameter group.

Arguments

  • dbcluster_parameter_group_name: The name of a specific cluster parameter group to return parameter details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup.

Optional Parameters

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

  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "Source": A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
Main.Docdb.describe_dbcluster_snapshot_attributesMethod
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier)
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier, params::Dict{String,<:Any})

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

Arguments

  • dbcluster_snapshot_identifier: The identifier for the cluster snapshot to describe the attributes for.
Main.Docdb.describe_dbcluster_snapshotsMethod
describe_dbcluster_snapshots()
describe_dbcluster_snapshots(params::Dict{String,<:Any})

Returns information about cluster snapshots. This API operation supports pagination.

Optional Parameters

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

  • "DBClusterIdentifier": The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive. Constraints: If provided, must match the identifier of an existing DBCluster.
  • "DBClusterSnapshotIdentifier": A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If provided, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
  • "Filters": This parameter is not currently supported.
  • "IncludePublic": Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.
  • "IncludeShared": Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "SnapshotType": The type of cluster snapshots to be returned. You can specify one of the following values: automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account. shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account. public - Return all cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
Main.Docdb.describe_dbclustersMethod
describe_dbclusters()
describe_dbclusters(params::Dict{String,<:Any})

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

Optional Parameters

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

  • "DBClusterIdentifier": The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive. Constraints: If provided, must match an existing DBClusterIdentifier.
  • "Filters": A filter that specifies one or more clusters to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_dbengine_versionsMethod
describe_dbengine_versions()
describe_dbengine_versions(params::Dict{String,<:Any})

Returns a list of the available engines.

Optional Parameters

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

  • "DBParameterGroupFamily": The name of a specific parameter group family to return details for. Constraints: If provided, must match an existing DBParameterGroupFamily.
  • "DefaultOnly": Indicates that only the default version of the specified engine or engine and major version combination is returned.
  • "Engine": The database engine to return.
  • "EngineVersion": The database engine version to return. Example: 3.6.0
  • "Filters": This parameter is not currently supported.
  • "ListSupportedCharacterSets": If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
  • "ListSupportedTimezones": If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_dbinstancesMethod
describe_dbinstances()
describe_dbinstances(params::Dict{String,<:Any})

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

Optional Parameters

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

  • "DBInstanceIdentifier": The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive. Constraints: If provided, must match the identifier of an existing DBInstance.
  • "Filters": A filter that specifies one or more instances to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs. db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_dbsubnet_groupsMethod
describe_dbsubnet_groups()
describe_dbsubnet_groups(params::Dict{String,<:Any})

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Optional Parameters

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

  • "DBSubnetGroupName": The name of the subnet group to return details for.
  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_engine_default_cluster_parametersMethod
describe_engine_default_cluster_parameters(dbparameter_group_family)
describe_engine_default_cluster_parameters(dbparameter_group_family, params::Dict{String,<:Any})

Returns the default engine and system parameter information for the cluster database engine.

Arguments

  • dbparameter_group_family: The name of the cluster parameter group family to return the engine parameter information for.

Optional Parameters

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

  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Main.Docdb.describe_event_categoriesMethod
describe_event_categories()
describe_event_categories(params::Dict{String,<:Any})

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Optional Parameters

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

  • "Filters": This parameter is not currently supported.
  • "SourceType": The type of source that is generating the events. Valid values: db-instance, db-parameter-group, db-security-group
Main.Docdb.describe_event_subscriptionsMethod
describe_event_subscriptions()
describe_event_subscriptions(params::Dict{String,<:Any})

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.

Optional Parameters

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

  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "SubscriptionName": The name of the Amazon DocumentDB event notification subscription that you want to describe.
Main.Docdb.describe_eventsMethod
describe_events()
describe_events(params::Dict{String,<:Any})

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Optional Parameters

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

  • "Duration": The number of minutes to retrieve events for. Default: 60
  • "EndTime": The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z
  • "EventCategories": A list of event categories that trigger notifications for an event notification subscription.
  • "Filters": This parameter is not currently supported.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "SourceIdentifier": The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is provided, SourceType must also be provided. If the source type is DBInstance, a DBInstanceIdentifier must be provided. If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided. If the source type is DBParameterGroup, a DBParameterGroupName must be provided. If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided. Cannot end with a hyphen or contain two consecutive hyphens.
  • "SourceType": The event source to retrieve events for. If no value is specified, all events are returned.
  • "StartTime": The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z
Main.Docdb.describe_global_clustersMethod
describe_global_clusters()
describe_global_clusters(params::Dict{String,<:Any})

Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters.

Optional Parameters

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

  • "Filters": A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
  • "GlobalClusterIdentifier": The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
  • "Marker": An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Main.Docdb.describe_orderable_dbinstance_optionsMethod
describe_orderable_dbinstance_options(engine)
describe_orderable_dbinstance_options(engine, params::Dict{String,<:Any})

Returns a list of orderable instance options for the specified engine.

Arguments

  • engine: The name of the engine to retrieve instance options for.

Optional Parameters

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

  • "DBInstanceClass": The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.
  • "EngineVersion": The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.
  • "Filters": This parameter is not currently supported.
  • "LicenseModel": The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "Vpc": The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
Main.Docdb.describe_pending_maintenance_actionsMethod
describe_pending_maintenance_actions()
describe_pending_maintenance_actions(params::Dict{String,<:Any})

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

Optional Parameters

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

  • "Filters": A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs. db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.
  • "Marker": An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • "MaxRecords": The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
  • "ResourceIdentifier": The ARN of a resource to return pending maintenance actions for.
Main.Docdb.failover_dbclusterMethod
failover_dbcluster()
failover_dbcluster(params::Dict{String,<:Any})

Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Optional Parameters

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

  • "DBClusterIdentifier": A cluster identifier to force a failover for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster.
  • "TargetDBInstanceIdentifier": The name of the instance to promote to the primary instance. You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.
Main.Docdb.list_tags_for_resourceMethod
list_tags_for_resource(resource_name)
list_tags_for_resource(resource_name, params::Dict{String,<:Any})

Lists all tags on an Amazon DocumentDB resource.

Arguments

  • resource_name: The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Optional Parameters

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

  • "Filters": This parameter is not currently supported.
Main.Docdb.modify_dbclusterMethod
modify_dbcluster(dbcluster_identifier)
modify_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Arguments

  • dbcluster_identifier: The cluster identifier for the cluster that is being modified. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster.

Optional Parameters

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

  • "ApplyImmediately": A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window. The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false
  • "BackupRetentionPeriod": The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to
  • "CloudwatchLogsExportConfiguration": The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
  • "DBClusterParameterGroupName": The name of the cluster parameter group to use for the cluster.
  • "DeletionProtection": Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  • "EngineVersion": The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.
  • "MasterUserPassword": The password for the master database user. 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.
  • "NewDBClusterIdentifier": The new cluster identifier for the cluster when renaming a cluster. This value 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-cluster2
  • "Port": The port number on which the cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original cluster.
  • "PreferredBackupWindow": The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
  • "PreferredMaintenanceWindow": The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is 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.
  • "VpcSecurityGroupIds": A list of virtual private cloud (VPC) security groups that the cluster will belong to.
Main.Docdb.modify_dbcluster_parameter_groupMethod
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter)
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter, params::Dict{String,<:Any})

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the charactersetdatabase parameter.

Arguments

  • dbcluster_parameter_group_name: The name of the cluster parameter group to modify.
  • parameter: A list of parameters in the cluster parameter group to modify.

Optional Parameters

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

  • "Parameters": A list of parameters in the cluster parameter group to modify.
Main.Docdb.modify_dbcluster_snapshot_attributeMethod
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier)
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier, params::Dict{String,<:Any})

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

Arguments

  • attribute_name: The name of the cluster snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.
  • dbcluster_snapshot_identifier: The identifier for the cluster snapshot to modify the attributes for.

Optional Parameters

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

  • "ValuesToAdd": A list of cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.
  • "ValuesToRemove": A list of cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
Main.Docdb.modify_dbinstanceMethod
modify_dbinstance(dbinstance_identifier)
modify_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Arguments

  • dbinstance_identifier: The instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.

Optional Parameters

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

  • "ApplyImmediately": Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance. If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot. Default: false
  • "AutoMinorVersionUpgrade": This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
  • "CACertificateIdentifier": Indicates the certificate that needs to be associated with the instance.
  • "CopyTagsToSnapshot": A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
  • "DBInstanceClass": The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions. If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting.
  • "EnablePerformanceInsights": A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
  • "NewDBInstanceIdentifier": The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value 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: mydbinstance
  • "PerformanceInsightsKMSKeyId": The KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
  • "PreferredMaintenanceWindow": The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Must be at least 30 minutes.
  • "PromotionTier": A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15
Main.Docdb.modify_dbsubnet_groupMethod
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier)
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

Arguments

  • dbsubnet_group_name: The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
  • subnet_identifier: The Amazon EC2 subnet IDs for the subnet group.

Optional Parameters

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

  • "DBSubnetGroupDescription": The description for the subnet group.
  • "SubnetIds": The Amazon EC2 subnet IDs for the subnet group.
Main.Docdb.modify_event_subscriptionMethod
modify_event_subscription(subscription_name)
modify_event_subscription(subscription_name, params::Dict{String,<:Any})

Modifies an existing Amazon DocumentDB event notification subscription.

Arguments

  • subscription_name: The name of the Amazon DocumentDB event notification subscription.

Optional Parameters

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

  • "Enabled": A Boolean value; set to true to activate the subscription.
  • "EventCategories": A list of event categories for a SourceType that you want to subscribe to.
  • "SnsTopicArn": The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
  • "SourceType": The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned. Valid values: db-instance, db-parameter-group, db-security-group
Main.Docdb.modify_global_clusterMethod
modify_global_cluster(global_cluster_identifier)
modify_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request. This action only applies to Amazon DocumentDB clusters.

Arguments

  • global_cluster_identifier: The identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global cluster.

Optional Parameters

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

  • "DeletionProtection": Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
  • "NewGlobalClusterIdentifier": The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string. Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
Main.Docdb.reboot_dbinstanceMethod
reboot_dbinstance(dbinstance_identifier)
reboot_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

Arguments

  • dbinstance_identifier: The instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.

Optional Parameters

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

  • "ForceFailover": When true, the reboot is conducted through a Multi-AZ failover. Constraint: You can't specify true if the instance is not configured for Multi-AZ.
Main.Docdb.remove_from_global_clusterMethod
remove_from_global_cluster(db_cluster_identifier, global_cluster_identifier)
remove_from_global_cluster(db_cluster_identifier, global_cluster_identifier, params::Dict{String,<:Any})

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. This action only applies to Amazon DocumentDB clusters.

Arguments

  • db_cluster_identifier: The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.
  • global_cluster_identifier: The cluster identifier to detach from the Amazon DocumentDB global cluster.
Main.Docdb.remove_source_identifier_from_subscriptionMethod
remove_source_identifier_from_subscription(source_identifier, subscription_name)
remove_source_identifier_from_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

Arguments

  • source_identifier: The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.
  • subscription_name: The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.
Main.Docdb.remove_tags_from_resourceMethod
remove_tags_from_resource(resource_name, tag_keys)
remove_tags_from_resource(resource_name, tag_keys, params::Dict{String,<:Any})

Removes metadata tags from an Amazon DocumentDB resource.

Arguments

  • resource_name: The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).
  • tag_keys: The tag key (name) of the tag to be removed.
Main.Docdb.reset_dbcluster_parameter_groupMethod
reset_dbcluster_parameter_group(dbcluster_parameter_group_name)
reset_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Arguments

  • dbcluster_parameter_group_name: The name of the cluster parameter group to reset.

Optional Parameters

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

  • "Parameters": A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.
  • "ResetAllParameters": A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
Main.Docdb.restore_dbcluster_from_snapshotMethod
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier)
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier, params::Dict{String,<:Any})

Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Arguments

  • dbcluster_identifier: The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive. 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-snapshot-id
  • engine: The database engine to use for the new cluster. Default: The same as source. Constraint: Must be compatible with the engine of the source.
  • snapshot_identifier: The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot. Constraints: Must match the identifier of an existing snapshot.

Optional Parameters

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

  • "AvailabilityZones": Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
  • "DBClusterParameterGroupName": The name of the DB cluster parameter group to associate with this DB cluster. Type: String.       Required: No. If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.
  • "DBSubnetGroupName": The name of the subnet group to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
  • "DeletionProtection": Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  • "EnableCloudwatchLogsExports": A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
  • "EngineVersion": The version of the database engine to use for the new cluster.
  • "KmsKeyId": The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot. If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
  • "Port": The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original cluster.
  • "Tags": The tags to be assigned to the restored cluster.
  • "VpcSecurityGroupIds": A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
Main.Docdb.restore_dbcluster_to_point_in_timeMethod
restore_dbcluster_to_point_in_time(dbcluster_identifier, source_dbcluster_identifier)
restore_dbcluster_to_point_in_time(dbcluster_identifier, source_dbcluster_identifier, params::Dict{String,<:Any})

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

Arguments

  • dbcluster_identifier: The name of the new cluster to be created. 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.
  • source_dbcluster_identifier: The identifier of the source cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.

Optional Parameters

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

  • "DBSubnetGroupName": The subnet group name to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
  • "DeletionProtection": Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
  • "EnableCloudwatchLogsExports": A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
  • "KmsKeyId": The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster. If the cluster is not encrypted, then the restored cluster is not encrypted. If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
  • "Port": The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The default port for the engine.
  • "RestoreToTime": The date and time to restore the cluster to. Valid values: A time in Universal Coordinated Time (UTC) format. Constraints: Must be before the latest restorable time for the instance. Must be specified if the UseLatestRestorableTime parameter is not provided. Cannot be specified if the UseLatestRestorableTime parameter is true. Cannot be specified if the RestoreType parameter is copy-on-write. Example: 2015-03-07T23:45:00Z
  • "RestoreType": The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
  • "Tags": The tags to be assigned to the restored cluster.
  • "UseLatestRestorableTime": A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if the RestoreToTime parameter is provided.
  • "VpcSecurityGroupIds": A list of VPC security groups that the new cluster belongs to.
Main.Docdb.start_dbclusterMethod
start_dbcluster(dbcluster_identifier)
start_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Arguments

  • dbcluster_identifier: The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
Main.Docdb.stop_dbclusterMethod
stop_dbcluster(dbcluster_identifier)
stop_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Arguments

  • dbcluster_identifier: The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52