mongodbatlas.v1alpha2.advancedCluster

"AdvancedCluster is the Schema for the AdvancedClusters API"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of AdvancedCluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"AdvancedClusterSpec defines the desired state of AdvancedCluster"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

fn spec.forProvider.withBackupEnabled

withBackupEnabled(backupEnabled)

fn spec.forProvider.withBiConnector

withBiConnector(biConnector)

fn spec.forProvider.withBiConnectorMixin

withBiConnectorMixin(biConnector)

Note: This function appends passed data to existing values

fn spec.forProvider.withClusterType

withClusterType(clusterType)

fn spec.forProvider.withDiskSizeGb

withDiskSizeGb(diskSizeGb)

fn spec.forProvider.withEncryptionAtRestProvider

withEncryptionAtRestProvider(encryptionAtRestProvider)

fn spec.forProvider.withLabels

withLabels(labels)

fn spec.forProvider.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

fn spec.forProvider.withMongoDbMajorVersion

withMongoDbMajorVersion(mongoDbMajorVersion)

fn spec.forProvider.withPaused

withPaused(paused)

fn spec.forProvider.withPitEnabled

withPitEnabled(pitEnabled)

fn spec.forProvider.withProjectId

withProjectId(projectId)

fn spec.forProvider.withReplicationSpecs

withReplicationSpecs(replicationSpecs)

fn spec.forProvider.withReplicationSpecsMixin

withReplicationSpecsMixin(replicationSpecs)

Note: This function appends passed data to existing values

fn spec.forProvider.withRootCertType

withRootCertType(rootCertType)

fn spec.forProvider.withVersionReleaseSystem

withVersionReleaseSystem(versionReleaseSystem)

obj spec.forProvider.biConnector

fn spec.forProvider.biConnector.withEnabled

withEnabled(enabled)

fn spec.forProvider.biConnector.withReadPreference

withReadPreference(readPreference)

obj spec.forProvider.labels

fn spec.forProvider.labels.withKey

withKey(key)

fn spec.forProvider.labels.withValue

withValue(value)

obj spec.forProvider.projectIdRef

"A Reference to a named object."

fn spec.forProvider.projectIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.projectIdSelector

"A Selector selects an object."

fn spec.forProvider.projectIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.projectIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.projectIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.replicationSpecs

fn spec.forProvider.replicationSpecs.withNumShards

withNumShards(numShards)

fn spec.forProvider.replicationSpecs.withRegionConfigs

withRegionConfigs(regionConfigs)

fn spec.forProvider.replicationSpecs.withRegionConfigsMixin

withRegionConfigsMixin(regionConfigs)

Note: This function appends passed data to existing values

fn spec.forProvider.replicationSpecs.withZoneName

withZoneName(zoneName)

obj spec.forProvider.replicationSpecs.regionConfigs

fn spec.forProvider.replicationSpecs.regionConfigs.withAnalyticsSpecs

withAnalyticsSpecs(analyticsSpecs)

fn spec.forProvider.replicationSpecs.regionConfigs.withAnalyticsSpecsMixin

withAnalyticsSpecsMixin(analyticsSpecs)

Note: This function appends passed data to existing values

fn spec.forProvider.replicationSpecs.regionConfigs.withAutoScaling

withAutoScaling(autoScaling)

fn spec.forProvider.replicationSpecs.regionConfigs.withAutoScalingMixin

withAutoScalingMixin(autoScaling)

Note: This function appends passed data to existing values

fn spec.forProvider.replicationSpecs.regionConfigs.withBackingProviderName

withBackingProviderName(backingProviderName)

fn spec.forProvider.replicationSpecs.regionConfigs.withElectableSpecs

withElectableSpecs(electableSpecs)

fn spec.forProvider.replicationSpecs.regionConfigs.withElectableSpecsMixin

withElectableSpecsMixin(electableSpecs)

Note: This function appends passed data to existing values

fn spec.forProvider.replicationSpecs.regionConfigs.withPriority

withPriority(priority)

fn spec.forProvider.replicationSpecs.regionConfigs.withProviderName

withProviderName(providerName)

fn spec.forProvider.replicationSpecs.regionConfigs.withReadOnlySpecs

withReadOnlySpecs(readOnlySpecs)

fn spec.forProvider.replicationSpecs.regionConfigs.withReadOnlySpecsMixin

withReadOnlySpecsMixin(readOnlySpecs)

Note: This function appends passed data to existing values

fn spec.forProvider.replicationSpecs.regionConfigs.withRegionName

withRegionName(regionName)

obj spec.forProvider.replicationSpecs.regionConfigs.analyticsSpecs

fn spec.forProvider.replicationSpecs.regionConfigs.analyticsSpecs.withDiskIops

withDiskIops(diskIops)

fn spec.forProvider.replicationSpecs.regionConfigs.analyticsSpecs.withEbsVolumeType

withEbsVolumeType(ebsVolumeType)

fn spec.forProvider.replicationSpecs.regionConfigs.analyticsSpecs.withInstanceSize

withInstanceSize(instanceSize)

fn spec.forProvider.replicationSpecs.regionConfigs.analyticsSpecs.withNodeCount

withNodeCount(nodeCount)

obj spec.forProvider.replicationSpecs.regionConfigs.autoScaling

fn spec.forProvider.replicationSpecs.regionConfigs.autoScaling.withComputeEnabled

withComputeEnabled(computeEnabled)

fn spec.forProvider.replicationSpecs.regionConfigs.autoScaling.withComputeMaxInstanceSize

withComputeMaxInstanceSize(computeMaxInstanceSize)

fn spec.forProvider.replicationSpecs.regionConfigs.autoScaling.withComputeMinInstanceSize

withComputeMinInstanceSize(computeMinInstanceSize)

fn spec.forProvider.replicationSpecs.regionConfigs.autoScaling.withComputeScaleDownEnabled

withComputeScaleDownEnabled(computeScaleDownEnabled)

fn spec.forProvider.replicationSpecs.regionConfigs.autoScaling.withDiskGbEnabled

withDiskGbEnabled(diskGbEnabled)

obj spec.forProvider.replicationSpecs.regionConfigs.electableSpecs

fn spec.forProvider.replicationSpecs.regionConfigs.electableSpecs.withDiskIops

withDiskIops(diskIops)

fn spec.forProvider.replicationSpecs.regionConfigs.electableSpecs.withEbsVolumeType

withEbsVolumeType(ebsVolumeType)

fn spec.forProvider.replicationSpecs.regionConfigs.electableSpecs.withInstanceSize

withInstanceSize(instanceSize)

fn spec.forProvider.replicationSpecs.regionConfigs.electableSpecs.withNodeCount

withNodeCount(nodeCount)

obj spec.forProvider.replicationSpecs.regionConfigs.readOnlySpecs

fn spec.forProvider.replicationSpecs.regionConfigs.readOnlySpecs.withDiskIops

withDiskIops(diskIops)

fn spec.forProvider.replicationSpecs.regionConfigs.readOnlySpecs.withEbsVolumeType

withEbsVolumeType(ebsVolumeType)

fn spec.forProvider.replicationSpecs.regionConfigs.readOnlySpecs.withInstanceSize

withInstanceSize(instanceSize)

fn spec.forProvider.replicationSpecs.regionConfigs.readOnlySpecs.withNodeCount

withNodeCount(nodeCount)

obj spec.providerConfigRef

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

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.writeConnectionSecretToRef

"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."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."