s3 - NexusOne

The s3 command manages S3 buckets.

`create`

The create subcommand creates a new S3 bucket record by specifying its connection details.

nx1 s3 create \
  --bucket <bucket_name> \
  --endpoint <s3_endpoint> \
  --access-key <access_key> \
  --secret-key <secret_key>

Options

string

required

Access key for the S3 bucket.

string

required

Name of the S3 bucket.

string

required

URL of the S3 endpoint.

string

required

Secret key for the S3 bucket.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`delete`

The delete subcommand deletes an existing S3 bucket from the system.

nx1 s3 delete bucket_name

Argument

string

required

Unique name of the S3 bucket to retrieve.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`get`

The get subcommand retrieves details about a specific S3 bucket.

nx1 s3 get bucket_name

Argument

string

required

Unique name of the S3 bucket to retrieve.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`list`

The list subcommand retrieves a list of all S3 bucket records.

nx1 s3
nx1 s3 list

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`refresh`

The refresh subcommand manually refreshes all S3 buckets.

nx1 s3 refresh

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

Using the CLIs

CLI tools

s3

`create`

`delete`

`get`

`list`

`refresh`

Using the CLIs

CLI tools

​create

​delete

​get

​list

​refresh

`create`

`delete`

`get`

`list`

`refresh`