clusters

Documentation

Overview

Copyright 2020 MongoDB Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func Builder() *cobra.Command
• func CreateBuilder() *cobra.Command
• func DeleteBuilder() *cobra.Command
• func DescribeBuilder() *cobra.Command
• func IndexesBuilder() *cobra.Command
• func IndexesCreateBuilder() *cobra.Command
• func ListBuilder() *cobra.Command
• func PauseBuilder() *cobra.Command
• func StartBuilder() *cobra.Command
• func UpdateBuilder() *cobra.Command
• func WatchBuilder() *cobra.Command
• type CreateOpts
  • func (opts *CreateOpts) Run() error
• type DeleteOpts
  • func (opts *DeleteOpts) Run() error
• type DescribeOpts
  • func (opts *DescribeOpts) Run() error
• type IndexesCreateOpts
  • func (opts *IndexesCreateOpts) Run() error
• type ListOpts
  • func (opts *ListOpts) Run() error
• type PauseOpts
  • func (opts *PauseOpts) Run() error
• type StartOpts
  • func (opts *StartOpts) Run() error
• type UpdateOpts
  • func (opts *UpdateOpts) Run() error
• type WatchOpts
  • func (opts *WatchOpts) Run() error

Constants

const (
	Clusters = "Manage clusters for your project."

	Indexes = "Manage cluster rolling indexes for your project."
)

Functions

func Builder

func Builder() *cobra.Command

func CreateBuilder

func CreateBuilder() *cobra.Command

CreateBuilder builds a cobra.Command that can run as: create <name> --projectId projectId --provider AWS|GCP|AZURE --region regionName [--members N] [--tier M#] [--diskSizeGB N] [--backup] [--mdbVersion]

func DeleteBuilder

func DeleteBuilder() *cobra.Command

mongocli atlas cluster(s) delete <name> --projectId projectId [--confirm]

func DescribeBuilder

func DescribeBuilder() *cobra.Command

mongocli atlas cluster(s) describe <name> --projectId projectId

func IndexesBuilder

func IndexesBuilder() *cobra.Command

func IndexesCreateBuilder

func IndexesCreateBuilder() *cobra.Command

IndexesCreateBuilder builds a cobra.Command that can run as: mcli atlas clusters index create [name] --clusterName clusterName --collection collection --dbName dbName [--key field:type]

func ListBuilder

func ListBuilder() *cobra.Command

mongocli atlas cluster(s) list --projectId projectId [--page N] [--limit N]

func PauseBuilder

func PauseBuilder() *cobra.Command

mongocli atlas cluster(s) pause <name> [--projectId projectId]

func StartBuilder

func StartBuilder() *cobra.Command

mongocli atlas cluster(s) start <name> [--projectId projectId]

func UpdateBuilder

func UpdateBuilder() *cobra.Command

mongocli atlas cluster(s) update [name] --projectId projectId [--tier M#] [--diskSizeGB N] [--mdbVersion]

func WatchBuilder

func WatchBuilder() *cobra.Command

mongocli atlas cluster(s) watch <name> [--projectId projectId]

Types

type CreateOpts

type CreateOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*CreateOpts) Run

func (opts *CreateOpts) Run() error

type DeleteOpts

type DeleteOpts struct {
	cli.GlobalOpts
	*cli.DeleteOpts
	// contains filtered or unexported fields
}

func (*DeleteOpts) Run

func (opts *DeleteOpts) Run() error

type DescribeOpts

type DescribeOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*DescribeOpts) Run

func (opts *DescribeOpts) Run() error

type IndexesCreateOpts

type IndexesCreateOpts struct {
	cli.GlobalOpts
	// contains filtered or unexported fields
}

func (*IndexesCreateOpts) Run

func (opts *IndexesCreateOpts) Run() error

type ListOpts

type ListOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.ListOpts
	// contains filtered or unexported fields
}

func (*ListOpts) Run

func (opts *ListOpts) Run() error

type PauseOpts

type PauseOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*PauseOpts) Run

func (opts *PauseOpts) Run() error

type StartOpts

type StartOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*StartOpts) Run

func (opts *StartOpts) Run() error

type UpdateOpts

type UpdateOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*UpdateOpts) Run

func (opts *UpdateOpts) Run() error

type WatchOpts

type WatchOpts struct {
	cli.GlobalOpts
	cli.WatchOpts
	// contains filtered or unexported fields
}

func (*WatchOpts) Run

func (opts *WatchOpts) Run() error