Docs Home → MongoDB Command Line Interface
mongocli ops-manager admin backups s3 update
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.
Update a backup S3 blockstore configuration.
Syntax
mongocli ops-manager admin backups s3 update <name> [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--acceptedTos | true | Flag indicating whether or not you accepted the terms of service for using S3-compatible stores with Ops Manager. | |
--assignment | false | Flag indicating whether this blockstore can be assigned backup jobs. | |
--awsAccessKey | string | false | AWS Access Key ID that can access the S3 bucket specified in s3BucketName. |
--awsSecretKey | string | false | AWS Secret Access Key that can access the S3 bucket specified in s3BucketName. |
--disableProxyS3 | false | Flag indicating whether the HTTP proxy should be used when connecting to S3. | |
--encryptedCredentials | false | Flag indicating whether the username and password were encrypted using the credentialstool. | |
-h, --help | false | help for update | |
--label | strings | false | Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. |
--loadFactor | int | false | A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. |
-o, --output | string | false | Output format.
Valid values: json|json-path|go-template|go-template-file |
--pathStyleAccessEnabled | false | Flag indicating the style of this endpoint. | |
--s3AuthMethod | string | true | Method used to authorize access to the S3 bucket specified in s3BucketName.
Valid values: KEYS|IAM_ROLE. |
--s3BucketEndpoint | string | true | URL that Ops Manager uses to access this AWS S3 or S3-compatible bucket. |
--s3BucketName | string | true | Name of the S3 bucket that hosts the S3 blockstore. |
--s3MaxConnections | int | false | Positive integer indicating the maximum number of connections to this S3 blockstore. |
--sseEnabled | false | Flag indicating whether this S3 blockstore enables server-side encryption. | |
--uri | string | true | A comma-separated list of hosts in the <hostname:port> format that can be used to access this blockstore. |
--writeConcern | string | false | The write concern used for this blockstore. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |