usage

Documentation

Index

• Constants

Constants

const (
	ProjectID                       = "Project ID to use. Overrides configuration file or environment variable settings."
	OrgID                           = "Organization ID to use. Overrides configuration file or environment variable settings."
	Profile                         = "Profile to use from your configuration file."
	Members                         = "Number of members in the replica set."
	Shards                          = "Number of shards in the cluster."
	ProcessName                     = "The unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}."
	Since                           = "Point in time, specified as milliseconds since the Unix Epoch, from which you want to receive results."
	HostID                          = "The unique identifier for the host of a MongoDB process. "
	Duration                        = "Length of time from the since parameter, in milliseconds, for which you want to receive results."
	Tier                            = "Tier for each data-bearing server in the cluster."
	NLog                            = "Maximum number of log lines to return."
	SlowQueryNamespaces             = "Namespaces from which to retrieve suggested slow query logs."
	DiskSizeGB                      = "Capacity, in gigabytes, of the host’s root volume."
	Backup                          = "If true, enables Continuous Cloud Backup for your cluster."
	SuggestedIndexNamespaces        = "Namespaces from which to retrieve suggested indexes. "
	NExamples                       = "Maximum number of examples queries to provide that will be improved by a suggested index."
	NIndexes                        = "Maximum number of indexes to suggest."
	MDBVersion                      = "MongoDB version of the cluster to deploy."
	AuthDB                          = "Authentication database name."
	Granularity                     = "Duration in ISO 8601 notation that specifies the interval between measurement data points."
	Page                            = "Page number."
	Forever                         = "Acknowledge an alert “forever”."
	Status                          = "Alert's status."
	Until                           = "Acknowledged until a date."
	Limit                           = "Number of items per page."
	Username                        = "Username of the user."
	TeamUsername                    = "List of usernames to add to the new team."
	DBUsername                      = "Username for authenticating to MongoDB."
	TeamName                        = "Name of the team."
	UserID                          = "The ID of the user."
	LDAPHostname                    = "The hostname or IP address of the LDAP server."
	LDAPPort                        = "The port to which the LDAP server listens for client connections."
	BindUsername                    = "The user DN that Atlas uses to connect to the LDAP server."
	BindPassword                    = "The password used to authenticate the bindUsername."
	CaCertificate                   = "CA certificate used to verify the identify of the LDAP server."
	AuthzQueryTemplate              = "An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs."
	AuthenticationEnabled           = "Specifies whether user authentication with LDAP is enabled."
	AuthorizationEnabled            = "Specifies whether user authorization with LDAP is enabled."
	TeamID                          = "The ID of the team."
	Password                        = "User’s password." //nolint:gosec // This is just a message not a password
	Country                         = "The ISO 3166-1 alpha 2 country code of the user’s country of residence."
	Mobile                          = "The user’s mobile or cell phone number."
	Period                          = "Duration in ISO 8601 notation that specifies how far back in the past to retrieve measurements."
	Roles                           = "User's roles and the databases or collections on which the roles apply."
	DataLakeRole                    = "Amazon Resource Name (ARN) of the role which Atlas Data Lake uses for accessing the data stores."
	DataLakeRegion                  = "Name of the region to which Data Lake routes client connections for data processing."
	DataLakeTestBucket              = `Name of an S3 data bucket which Data Lake uses to validate the provided role.`
	PrivateEndpointRegion           = "Cloud provider region in which you want to create the private endpoint connection."
	PrivateEndpointProvider         = "Name of the cloud provider you want to create the private endpoint connection for."
	Comment                         = "Optional description or comment for the entry."
	WhiteListsDeleteAfter           = "ISO-8601-formatted UTC date after which Atlas removes the entry from the whitelist."
	BDUsersDeleteAfter              = "Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user."
	Force                           = "Don't ask for confirmation."
	Email                           = "User’s email address."
	LogOut                          = "Optional output filename, if none given will use the log name."
	DiagnoseOut                     = "Optional output filename, if none given will use diagnose-archive.tar.gz."
	LogStart                        = "Beginning of the period for which to retrieve logs."
	LogEnd                          = "End of the period for which to retrieve logs."
	ArchiveLimit                    = "Max number of entries for the diagnose archive."
	ArchiveMinutes                  = "Beginning of the period for which to retrieve diagnose archive. Ops Manager takes out minutes from the current time. "
	MeasurementStart                = "Beginning of the period for which to retrieve measurements."
	MeasurementEnd                  = "End of the period for which to retrieve measurements."
	MeasurementType                 = "Measurements to return. If it is not specified, all measurements are returned."
	FirstName                       = "User’s first name."
	LastName                        = "User’s last name."
	OrgRole                         = "User's roles  for the associated organization."
	ProjectRole                     = "User's roles  for the associated project."
	TeamRole                        = "Project role you want to assign to the team."
	MaxDate                         = "Returns events whose created date is less than or equal to it."
	MinDate                         = "Returns events whose created date is greater than or equal to it."
	Filename                        = "Filename to use, optional file with a json cluster configuration."
	WhitelistIps                    = "IP addresses to add to the new user’s whitelist."
	StartDate                       = "Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts."
	EndDate                         = "Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends."
	AlertType                       = "Alert types to silence during maintenance window. For example: HOST, REPLICA_SET, CLUSTER, AGENT, BACKUP."
	MaintenanceDescription          = "Description of the maintenance window."
	Event                           = "Type of event that will trigger an alert."
	Enabled                         = "If set to true, the alert configuration is enabled."
	MatcherFieldName                = "Name of the field in the target object to match on."
	MatcherOperator                 = "The operator to test the field’s value."
	MatcherValue                    = "Value to test with the specified operator."
	MetricName                      = "Name of the metric against which Atlas checks the configured"
	MetricOperator                  = "Operator to apply when checking the current metric value against the threshold value."
	MetricThreshold                 = "Threshold value outside of which an alert will be triggered."
	MetricUnits                     = "The units for the threshold value."
	MetricMode                      = "Atlas computes the current metric value as an average."
	NotificationToken               = "Slack API token or Bot token or Flowdock personal API token." //nolint:gosec // This is just a message not a password
	NotificationsChannelName        = "Slack channel name. Required for the SLACK notifications type."
	AlertConfigAPIKey               = "Datadog API Key, Opsgenie API Key, VictorOps API key."
	APIKey                          = "API Key."
	RoutingKey                      = "An optional field for your Routing Key."
	IntegrationAPIToken             = "Your API Token." //nolint:gosec // This is just a message not a credential
	OrgName                         = "Your Flowdock organization name."
	FlowName                        = "Your Flowdock Flow name."
	APIKeyDescription               = "Description of the API key."
	APIKeyRoles                     = "List of roles for the API key."
	NotificationRegion              = "Region that indicates which API URL to use."
	NotificationDelayMin            = "Number of minutes to wait after an alert condition is detected before sending out the first notification."
	NotificationEmailAddress        = "Email address to which alert notifications are sent."
	NotificationEmailEnabled        = "Flag indicating if email notifications should be sent."
	NotificationFlowName            = "Flowdock flow name in lower-case letters."
	NotificationIntervalMin         = "Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved."
	NotificationMobileNumber        = "Mobile number to which alert notifications are sent."
	NotificationOrgName             = "Flowdock organization name in lower-case letters."
	NotificationServiceKey          = "PagerDuty service key."
	NotificationSmsEnabled          = "Flag indicating if text message notifications should be sent."
	NotificationTeamID              = "Unique identifier of a team."
	NotificationType                = "Type of alert notification."
	NotificationUsername            = "Name of the Atlas user to which to send notifications."
	NotificationVictorOpsRoutingKey = "VictorOps routing key."
	SnapshotID                      = "Unique identifier of the snapshot to restore."
	SnapshotDescription             = "Description of the on-demand snapshot."
	SnapshotRetention               = "The number of days that Atlas should retain the on-demand snapshot."
	Database                        = "Database name."
	DatabaseUser                    = "Username of a database user."
	MonthsUntilExpiration           = "Number of months that the certificate is valid for."
	Collection                      = "Collection name."
	Analyzer                        = "Analyzer to use when creating the index"
	SearchAnalyzer                  = "Analyzer to use when searching the index."
	Dynamic                         = "Indicates whether the index uses dynamic or static mappings."
	SearchFields                    = "Static field specifications."
	RSName                          = "The replica set that the index is built on."
	Key                             = "Index keys. Should be formatted as field:type."
	Unique                          = "Create a unique key index."
	LogTypes                        = "Array of strings specifying the types of logs to collect."
	SizeRequestedPerFileBytes       = "Size for each log file in bytes."
	LogRedacted                     = "" /* 139-byte string literal not displayed */
	Sparse                          = "Create a sparse index."
	Locale                          = "Locale that the ICU defines."
	CaseLevel                       = "If set to true, the index uses case comparison. This field applies only if the strength level is set to 1 or 2."
	CaseFirst                       = "Determines the sort order of case differences during tertiary level comparisons. "
	Strength                        = "Level of comparison to perform."
	Alternate                       = "Determines whether collation should consider whitespace and punctuation as base characters during comparisons."
	MaxVariable                     = "" /* 136-byte string literal not displayed */
	NumericOrdering                 = "If set to true, collation compares numeric strings as numbers. If false, collation compares numeric strings as strings."
	Normalization                   = "If true, collation checks if text requires normalization and performs normalization to compare text."
	Backwards                       = "If true, strings with diacritics sort from the back to the front of the string."
	ClusterName                     = "Name of the cluster."
	CASFilePath                     = "Path to a PEM file containing one or more CAs for database user authentication."
	Verbose                         = "If true, returns all child jobs in the response."
	ClusterID                       = "Unique identifier of the cluster."
	Background                      = "Create the index in the background."
	DateField                       = "Name of an already indexed date field from the documents."
	PartitionFields                 = "Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data."
	ArchiveAfter                    = "Number of days that specifies the age limit for the data in the live Atlas cluster."
	TargetProjectID                 = "Unique identifier of the project that contains the destination cluster for the restore job."
	WhitelistIPEntry                = "IP address to be whitelisted for a given API key."
	WhitelistCIDREntry              = "Whitelist entry in CIDR notation to be added for a given API key."
	PrivateEndpointID               = "Unique identifier of the AWS PrivateLink connection."
	AccountID                       = "Account ID of the owner of the peer VPC."
	NewRelicAccountID               = "Unique identifier of your New Relic account."
	LicenceKey                      = "Your License Key."
	ServiceKey                      = "Your Service Key."
	URL                             = "Your webhook URL."
	Secret                          = "An optional field for your webhook secret." //nolint:gosec // This is just a message not a credential
	WriteToken                      = "Your Insights Insert Key."
	DayOfWeek                       = "Day of the week that you want the maintenance window to start, as a 1-based integer."
	HourOfDay                       = "" /* 137-byte string literal not displayed */
	StartASAP                       = "Start maintenance immediately upon receiving this request."
	ReadToken                       = "Your Insights Query Key."
	RouteTableCidrBlock             = "Peer VPC CIDR block or subnet."
	VpcID                           = "Unique identifier of the peer VPC."
	AtlasCIDRBlock                  = "CIDR block that Atlas uses for your clusters."
	VNet                            = "Name of your Azure VNet."
	ResourceGroup                   = "Name of your Azure resource group."
	DirectoryID                     = "Unique identifier for an Azure AD directory."
	SubscriptionID                  = "Unique identifier of the Azure subscription in which the VNet resides."
	GCPProjectID                    = "Unique identifier of the GCP project in which the network peer resides."
	Network                         = "Unique identifier of the Network Peering connection in the Atlas project."
	APIRegion                       = "Indicates which API URL to use, either US or EU. The integration service will use US by default."
	FormatOut                       = `Output format. 
Valid values: json`
	TargetClusterID = `Unique identifier of the target cluster.
For use only with automated restore jobs.`
	TargetClusterName = `Name of the target cluster.
For use only with automated restore jobs.`
	CheckpointID = `` /* 219-byte string literal not displayed */

	OplogTS = `` /* 199-byte string literal not displayed */

	OplogInc = `` /* 174-byte string literal not displayed */

	PointInTimeUTCMillis = `` /* 214-byte string literal not displayed */

	Expires = `` /* 127-byte string literal not displayed */

	ExpirationHours = `Number of hours the download URL is valid once the restore job is complete.
For use only with download restore jobs.`
	MaxDownloads = `Number of times the download URL can be used. This must be 1 or greater.
For use only with download restore jobs.`
	Mechanisms = `Authentication mechanism. 
Valid values: SCRAM-SHA-1|SCRAM-SHA-256`
	WhitelistType = `Type of whitelist entry.
Valid values: cidrBlock|ipAddress|awsSecurityGroup`
	Service = `Type of MongoDB service.
Valid values: cloud|cloud-manager|ops-manager`
	Provider = `Name of your cloud service provider.
Valid values: AWS|AZURE|GCP.`
	ClusterTypes = `Type of the cluster that you want to create.
Valid values: REPLICASET|SHARDED.`
	Region = `` /* 399-byte string literal not displayed */

	AWSIAMType = `AWS IAM method by which the provided username is authenticated. 
Valid values: NONE|USER|ROLE.`
	X509Type = `X.509 method by which the provided username is authenticated. 
Valid values: NONE|MANAGED|CUSTOMER.`
	LDAPType = `LDAP method by which the provided username is authenticated. 
Valid values: NONE|USER|GROUP.`
)