yandexcloud/crossplane-provider-yc@v0.5.1
MongodbCluster
mdb.yandex-cloud.jet.crossplane.io
MongodbCluster
yandexcloud/crossplane-provider-yc@v0.5.1mdb.yandex-cloud.jet.crossplane.io

MongodbCluster is the Schema for the MongodbClusters API. Manages a MongoDB cluster within Yandex.Cloud.

Type

CRD

Group

mdb.yandex-cloud.jet.crossplane.io

Version

v1alpha1

apiVersion: mdb.yandex-cloud.jet.crossplane.io/v1alpha1

kind: MongodbCluster

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

MongodbClusterSpec defines the desired state of MongodbCluster

forProvider
requiredobject
requiredobject

No description provided.

array

Configuration of the MongoDB subcluster. The structure is documented below.

access
array
array

Access policy to the MongoDB cluster. The structure is documented below.

dataLens
boolean
array

Time to start the daily backup, in the UTC timezone. The structure is documented below.

hours
integer
minutes
integer
array

Configuration of the mongocfg service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

mode
string
storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongod
array
array

Configuration of the mongod service. The structure is documented below.

array

A set of audit log settings (see the auditLog option). The structure is documented below. Available only in enterprise edition.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

array

A set of MongoDB Security settings (see the security option). The structure is documented below. Available only in enterprise edition.

kmip
array
array

Configuration of the third party key management appliance via the Key Management Interoperability Protocol (KMIP) (see Encryption tutorial ). Requires enable_encryption to be true. The structure is documented below. Available only in enterprise edition.

array

A set of MongoDB Server Parameters (see the setParameter option). The structure is documented below.

storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

journal
array
array

The durability journal to ensure data files remain valid and recoverable. The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongos
array
array

Configuration of the mongos service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

Performance diagnostics to the MongoDB cluster. The structure is documented below.

enabled
boolean
version
string
clusterId
string
array

A database of the MongoDB cluster. The structure is documented below.

name
string
folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

policy
object
object

Policies for selection.

resolve
string
host
array
array

A host of the MongoDB cluster. The structure is documented below.

role
string
shardName
string
subnetId
string
object

Reference to a Subnet in vpc to populate subnetId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnet in vpc to populate subnetId.

policy
object
object

Policies for selection.

resolve
string
type
string
zoneId
string
labels
object
array

Maintenance window settings of the MongoDB cluster. The structure is documented below.

day
string
hour
integer
type
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

policy
object
object

Policies for selection.

resolve
string
array

(DEPRECATED, use resources_* instead) Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongocfg hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongod hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongoinfra hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongos hosts of the MongoDB cluster. The structure is documented below.

restore
array
array

The cluster will be created from the specified backup. The structure is documented below.

backupId
string
time
string
array

A set of ids of security groups assigned to hosts of the cluster.

array

References to SecurityGroup in vpc to populate securityGroupIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in vpc to populate securityGroupIds.

policy
object
object

Policies for selection.

resolve
string
user
array
array

A user of the MongoDB cluster. The structure is documented below.

name
string
passwordSecretRef
requiredobject
requiredobject

The password of the user.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

Set of permissions granted to the user. The structure is documented below.

roles
array
array

The roles of the user in this database. For more information see the official documentation.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Configuration of the MongoDB subcluster. The structure is documented below.

access
array
array

Access policy to the MongoDB cluster. The structure is documented below.

dataLens
boolean
array

Time to start the daily backup, in the UTC timezone. The structure is documented below.

hours
integer
minutes
integer
array

Configuration of the mongocfg service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

mode
string
storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongod
array
array

Configuration of the mongod service. The structure is documented below.

array

A set of audit log settings (see the auditLog option). The structure is documented below. Available only in enterprise edition.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

array

A set of MongoDB Security settings (see the security option). The structure is documented below. Available only in enterprise edition.

kmip
array
array

Configuration of the third party key management appliance via the Key Management Interoperability Protocol (KMIP) (see Encryption tutorial ). Requires enable_encryption to be true. The structure is documented below. Available only in enterprise edition.

array

A set of MongoDB Server Parameters (see the setParameter option). The structure is documented below.

storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

journal
array
array

The durability journal to ensure data files remain valid and recoverable. The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongos
array
array

Configuration of the mongos service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

Performance diagnostics to the MongoDB cluster. The structure is documented below.

enabled
boolean
version
string
clusterId
string
array

A database of the MongoDB cluster. The structure is documented below.

name
string
folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

policy
object
object

Policies for selection.

resolve
string
host
array
array

A host of the MongoDB cluster. The structure is documented below.

role
string
shardName
string
subnetId
string
object

Reference to a Subnet in vpc to populate subnetId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnet in vpc to populate subnetId.

policy
object
object

Policies for selection.

resolve
string
type
string
zoneId
string
labels
object
array

Maintenance window settings of the MongoDB cluster. The structure is documented below.

day
string
hour
integer
type
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

policy
object
object

Policies for selection.

resolve
string
array

(DEPRECATED, use resources_* instead) Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongocfg hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongod hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongoinfra hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongos hosts of the MongoDB cluster. The structure is documented below.

restore
array
array

The cluster will be created from the specified backup. The structure is documented below.

backupId
string
time
string
array

A set of ids of security groups assigned to hosts of the cluster.

array

References to SecurityGroup in vpc to populate securityGroupIds.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in vpc to populate securityGroupIds.

policy
object
object

Policies for selection.

resolve
string
user
array
array

A user of the MongoDB cluster. The structure is documented below.

name
string
array

Set of permissions granted to the user. The structure is documented below.

roles
array
array

The roles of the user in this database. For more information see the official documentation.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

MongodbClusterStatus defines the observed state of MongodbCluster.

object

No description provided.

array

Configuration of the MongoDB subcluster. The structure is documented below.

access
array
array

Access policy to the MongoDB cluster. The structure is documented below.

dataLens
boolean
array

Time to start the daily backup, in the UTC timezone. The structure is documented below.

hours
integer
minutes
integer
array

Configuration of the mongocfg service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

mode
string
storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongod
array
array

Configuration of the mongod service. The structure is documented below.

array

A set of audit log settings (see the auditLog option). The structure is documented below. Available only in enterprise edition.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

A set of profiling settings (see the operationProfiling option). The structure is documented below.

array

A set of MongoDB Security settings (see the security option). The structure is documented below. Available only in enterprise edition.

kmip
array
array

Configuration of the third party key management appliance via the Key Management Interoperability Protocol (KMIP) (see Encryption tutorial ). Requires enable_encryption to be true. The structure is documented below. Available only in enterprise edition.

array

A set of MongoDB Server Parameters (see the setParameter option). The structure is documented below.

storage
array
array

A set of storage settings (see the storage option). The structure is documented below.

journal
array
array

The durability journal to ensure data files remain valid and recoverable. The structure is documented below.

array

The WiredTiger engine settings. (see the storage.wiredTiger option). These settings available only on mongod hosts. The structure is documented below.

mongos
array
array

Configuration of the mongos service. The structure is documented below.

net
array
array

A set of network settings (see the net option). The structure is documented below.

array

Specifies the default compressor(s) to use for communication between this mongod or mongos. Accepts array of compressors. Order matters. Available compressors: snappy, zlib, zstd, disabled. To disable network compression, make "disabled" the only value. For more information, see the net.Compression.Compressors description in the official documentation.

array

Performance diagnostics to the MongoDB cluster. The structure is documented below.

enabled
boolean
version
string
clusterId
string
createdAt
string
array

A database of the MongoDB cluster. The structure is documented below.

name
string
folderId
string
health
string
host
array
array

A host of the MongoDB cluster. The structure is documented below.

health
string
name
string
role
string
shardName
string
subnetId
string
type
string
zoneId
string
id
string
labels
object
array

Maintenance window settings of the MongoDB cluster. The structure is documented below.

day
string
hour
integer
type
string
name
string
networkId
string
array

(DEPRECATED, use resources_* instead) Resources allocated to hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongocfg hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongod hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongoinfra hosts of the MongoDB cluster. The structure is documented below.

array

Resources allocated to mongos hosts of the MongoDB cluster. The structure is documented below.

restore
array
array

The cluster will be created from the specified backup. The structure is documented below.

backupId
string
time
string
array

A set of ids of security groups assigned to hosts of the cluster.

sharded
boolean
status
string
user
array
array

A user of the MongoDB cluster. The structure is documented below.

name
string
array

Set of permissions granted to the user. The structure is documented below.

roles
array
array

The roles of the user in this database. For more information see the official documentation.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions