Client

docdb

R Documentation

Amazon DocumentDB with MongoDB compatibility¶

Description¶

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

Usage¶

docdb(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- docdb(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

add_source_identifier_to_subscription: Adds a source identifier to an existing event notification subscription
add_tags_to_resource: Adds metadata tags to an Amazon DocumentDB resource
apply_pending_maintenance_action: Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance)
copy_db_cluster_parameter_group: Copies the specified cluster parameter group
copy_db_cluster_snapshot: Copies a snapshot of a cluster
create_db_cluster: Creates a new Amazon DocumentDB cluster
create_db_cluster_parameter_group: Creates a new cluster parameter group
create_db_cluster_snapshot: Creates a snapshot of a cluster
create_db_instance: Creates a new instance
create_db_subnet_group: Creates a new subnet group
create_event_subscription: Creates an Amazon DocumentDB event notification subscription
create_global_cluster: Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions
delete_db_cluster: Deletes a previously provisioned cluster
delete_db_cluster_parameter_group: Deletes a specified cluster parameter group
delete_db_cluster_snapshot: Deletes a cluster snapshot
delete_db_instance: Deletes a previously provisioned instance
delete_db_subnet_group: Deletes a subnet group
delete_event_subscription: Deletes an Amazon DocumentDB event notification subscription
delete_global_cluster: Deletes a global cluster
describe_certificates: Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account
describe_db_cluster_parameter_groups: Returns a list of DBClusterParameterGroup descriptions
describe_db_cluster_parameters: Returns the detailed parameter list for a particular cluster parameter group
describe_db_clusters: Returns information about provisioned Amazon DocumentDB clusters; Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot
describe_db_cluster_snapshots: Returns information about cluster snapshots
describe_db_engine_versions: Returns a list of the available engines
describe_db_instances: Returns information about provisioned Amazon DocumentDB instances
describe_db_subnet_groups: Returns a list of DBSubnetGroup descriptions; Returns the default engine and system parameter information for the cluster database engine
describe_event_categories: Displays a list of categories for all event source types, or, if specified, for a specified source type
describe_events: Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days
describe_event_subscriptions: Lists all the subscription descriptions for a customer account
describe_global_clusters: Returns information about Amazon DocumentDB global clusters; Returns a list of orderable instance options for the specified engine
describe_pending_maintenance_actions: Returns a list of resources (for example, instances) that have at least one pending maintenance action
failover_db_cluster: Forces a failover for a cluster
failover_global_cluster: Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs
list_tags_for_resource: Lists all tags on an Amazon DocumentDB resource
modify_db_cluster: Modifies a setting for an Amazon DocumentDB cluster
modify_db_cluster_parameter_group: Modifies the parameters of a cluster parameter group
modify_db_cluster_snapshot_attribute: Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot
modify_db_instance: Modifies settings for an instance
modify_db_subnet_group: Modifies an existing subnet group
modify_event_subscription: Modifies an existing Amazon DocumentDB event notification subscription
modify_global_cluster: Modify a setting for an Amazon DocumentDB global cluster
reboot_db_instance: You might need to reboot your instance, usually for maintenance reasons
remove_from_global_cluster: Detaches an Amazon DocumentDB secondary cluster from a global cluster; Removes a source identifier from an existing Amazon DocumentDB event notification subscription
remove_tags_from_resource: Removes metadata tags from an Amazon DocumentDB resource
reset_db_cluster_parameter_group: Modifies the parameters of a cluster parameter group to the default value
restore_db_cluster_from_snapshot: Creates a new cluster from a snapshot or cluster snapshot
restore_db_cluster_to_point_in_time: Restores a cluster to an arbitrary point in time
start_db_cluster: Restarts the stopped cluster that is specified by DBClusterIdentifier
stop_db_cluster: Stops the running cluster that is specified by DBClusterIdentifier
switchover_global_cluster: Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster

Examples¶

## Not run: 
svc <- docdb()
svc$add_source_identifier_to_subscription(
  Foo = 123
)

## End(Not run)