Skip to content

cosmosdb.v1beta1.account

"Account is the Schema for the Accounts API. Manages a CosmosDB (formally DocumentDB) Account."

Index

Fields

fn new

new(name)

new returns an instance of Account

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"

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

"AccountSpec defines the desired state of Account"

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

withAccessKeyMetadataWritesEnabled(accessKeyMetadataWritesEnabled)

"Is write operations on metadata resources (databases, containers, throughput) via account keys enabled? Defaults to true."

fn spec.forProvider.withAnalyticalStorage

withAnalyticalStorage(analyticalStorage)

"An analytical_storage block as defined below."

fn spec.forProvider.withAnalyticalStorageEnabled

withAnalyticalStorageEnabled(analyticalStorageEnabled)

"Enable Analytical Storage option for this Cosmos DB account. Defaults to false. Enabling and then disabling analytical storage forces a new resource to be created."

fn spec.forProvider.withAnalyticalStorageMixin

withAnalyticalStorageMixin(analyticalStorage)

"An analytical_storage block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withBackup

withBackup(backup)

"A backup block as defined below."

fn spec.forProvider.withBackupMixin

withBackupMixin(backup)

"A backup block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCapabilities

withCapabilities(capabilities)

"The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below."

fn spec.forProvider.withCapabilitiesMixin

withCapabilitiesMixin(capabilities)

"The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCapacity

withCapacity(capacity)

"A capacity block as defined below."

fn spec.forProvider.withCapacityMixin

withCapacityMixin(capacity)

"A capacity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withConsistencyPolicy

withConsistencyPolicy(consistencyPolicy)

"Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account."

fn spec.forProvider.withConsistencyPolicyMixin

withConsistencyPolicyMixin(consistencyPolicy)

"Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account."

Note: This function appends passed data to existing values

fn spec.forProvider.withCorsRule

withCorsRule(corsRule)

"A cors_rule block as defined below."

fn spec.forProvider.withCorsRuleMixin

withCorsRuleMixin(corsRule)

"A cors_rule block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCreateMode

withCreateMode(createMode)

"The creation mode for the CosmosDB Account. Possible values are Default and Restore. Changing this forces a new resource to be created."

fn spec.forProvider.withDefaultIdentityType

withDefaultIdentityType(defaultIdentityType)

"The default identity for accessing Key Vault. Possible values are FirstPartyIdentity, SystemAssignedIdentity or start with UserAssignedIdentity."

fn spec.forProvider.withEnableAutomaticFailover

withEnableAutomaticFailover(enableAutomaticFailover)

"Enable automatic failover for this Cosmos DB account."

fn spec.forProvider.withEnableFreeTier

withEnableFreeTier(enableFreeTier)

"Enable the Free Tier pricing option for this Cosmos DB account. Defaults to false. Changing this forces a new resource to be created."

fn spec.forProvider.withEnableMultipleWriteLocations

withEnableMultipleWriteLocations(enableMultipleWriteLocations)

"Enable multiple write locations for this Cosmos DB account."

fn spec.forProvider.withGeoLocation

withGeoLocation(geoLocation)

"Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below."

fn spec.forProvider.withGeoLocationMixin

withGeoLocationMixin(geoLocation)

"Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIdentity

withIdentity(identity)

"An identity block as defined below."

fn spec.forProvider.withIdentityMixin

withIdentityMixin(identity)

"An identity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIpRangeFilter

withIpRangeFilter(ipRangeFilter)

"CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces."

fn spec.forProvider.withIsVirtualNetworkFilterEnabled

withIsVirtualNetworkFilterEnabled(isVirtualNetworkFilterEnabled)

"Enables virtual network filtering for this Cosmos DB account."

fn spec.forProvider.withKeyVaultKeyId

withKeyVaultKeyId(keyVaultKeyId)

"A versionless Key Vault Key ID for CMK encryption. Changing this forces a new resource to be created."

fn spec.forProvider.withKind

withKind(kind)

"Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB, MongoDB and Parse. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created."

fn spec.forProvider.withLocalAuthenticationDisabled

withLocalAuthenticationDisabled(localAuthenticationDisabled)

"Disable local authentication and ensure only MSI and AAD can be used exclusively for authentication. Defaults to false. Can be set only when using the SQL API."

fn spec.forProvider.withLocation

withLocation(location)

"Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created."

fn spec.forProvider.withMongoServerVersion

withMongoServerVersion(mongoServerVersion)

"The Server Version of a MongoDB account. Possible values are 4.2, 4.0, 3.6, and 3.2."

fn spec.forProvider.withNetworkAclBypassForAzureServices

withNetworkAclBypassForAzureServices(networkAclBypassForAzureServices)

"If Azure services can bypass ACLs. Defaults to false."

fn spec.forProvider.withNetworkAclBypassIds

withNetworkAclBypassIds(networkAclBypassIds)

"The list of resource Ids for Network Acl Bypass for this Cosmos DB account."

fn spec.forProvider.withNetworkAclBypassIdsMixin

withNetworkAclBypassIdsMixin(networkAclBypassIds)

"The list of resource Ids for Network Acl Bypass for this Cosmos DB account."

Note: This function appends passed data to existing values

fn spec.forProvider.withOfferType

withOfferType(offerType)

"Specifies the Offer Type to use for this CosmosDB Account; currently, this can only be set to Standard."

fn spec.forProvider.withPublicNetworkAccessEnabled

withPublicNetworkAccessEnabled(publicNetworkAccessEnabled)

"Whether or not public network access is allowed for this CosmosDB account. Defaults to true."

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created."

fn spec.forProvider.withRestore

withRestore(restore)

"A restore block as defined below."

fn spec.forProvider.withRestoreMixin

withRestoreMixin(restore)

"A restore block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags to assign to the resource."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags to assign to the resource."

Note: This function appends passed data to existing values

fn spec.forProvider.withVirtualNetworkRule

withVirtualNetworkRule(virtualNetworkRule)

"Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account."

fn spec.forProvider.withVirtualNetworkRuleMixin

withVirtualNetworkRuleMixin(virtualNetworkRule)

"Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account."

Note: This function appends passed data to existing values

obj spec.forProvider.analyticalStorage

"An analytical_storage block as defined below."

fn spec.forProvider.analyticalStorage.withSchemaType

withSchemaType(schemaType)

"The schema type of the Analytical Storage for this Cosmos DB account. Possible values are FullFidelity and WellDefined."

obj spec.forProvider.backup

"A backup block as defined below."

fn spec.forProvider.backup.withIntervalInMinutes

withIntervalInMinutes(intervalInMinutes)

"The interval in minutes between two backups. This is configurable only when type is Periodic. Possible values are between 60 and 1440."

fn spec.forProvider.backup.withRetentionInHours

withRetentionInHours(retentionInHours)

"The time in hours that each backup is retained. This is configurable only when type is Periodic. Possible values are between 8 and 720."

fn spec.forProvider.backup.withStorageRedundancy

withStorageRedundancy(storageRedundancy)

"The storage redundancy is used to indicate the type of backup residency. This is configurable only when type is Periodic. Possible values are Geo, Local and Zone."

fn spec.forProvider.backup.withType

withType(type)

"The type of the backup. Possible values are Continuous and Periodic. Migration of Periodic to Continuous is one-way, changing Continuous to Periodic forces a new resource to be created."

obj spec.forProvider.capabilities

"The capabilities which should be enabled for this Cosmos DB account. Value is a capabilities block as defined below."

fn spec.forProvider.capabilities.withName

withName(name)

"The capability to enable - Possible values are AllowSelfServeUpgradeToMongo36, DisableRateLimitingResponses, EnableAggregationPipeline, EnableCassandra, EnableGremlin, EnableMongo, EnableMongo16MBDocumentSupport, EnableMongoRetryableWrites, EnableMongoRoleBasedAccessControl, EnableServerless, EnableTable, EnableUniqueCompoundNestedDocs, MongoDBv3.4 and mongoEnableDocLevelTTL."

obj spec.forProvider.capacity

"A capacity block as defined below."

fn spec.forProvider.capacity.withTotalThroughputLimit

withTotalThroughputLimit(totalThroughputLimit)

"The total throughput limit imposed on this Cosmos DB account (RU/s). Possible values are at least -1. -1 means no limit."

obj spec.forProvider.consistencyPolicy

"Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account."

fn spec.forProvider.consistencyPolicy.withConsistencyLevel

withConsistencyLevel(consistencyLevel)

"The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix."

fn spec.forProvider.consistencyPolicy.withMaxIntervalInSeconds

withMaxIntervalInSeconds(maxIntervalInSeconds)

"When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. The accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistency_level is set to BoundedStaleness."

fn spec.forProvider.consistencyPolicy.withMaxStalenessPrefix

withMaxStalenessPrefix(maxStalenessPrefix)

"When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. The accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistency_level is set to BoundedStaleness."

obj spec.forProvider.corsRule

"A cors_rule block as defined below."

fn spec.forProvider.corsRule.withAllowedHeaders

withAllowedHeaders(allowedHeaders)

"A list of headers that are allowed to be a part of the cross-origin request."

fn spec.forProvider.corsRule.withAllowedHeadersMixin

withAllowedHeadersMixin(allowedHeaders)

"A list of headers that are allowed to be a part of the cross-origin request."

Note: This function appends passed data to existing values

fn spec.forProvider.corsRule.withAllowedMethods

withAllowedMethods(allowedMethods)

"A list of HTTP headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH."

fn spec.forProvider.corsRule.withAllowedMethodsMixin

withAllowedMethodsMixin(allowedMethods)

"A list of HTTP headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH."

Note: This function appends passed data to existing values

fn spec.forProvider.corsRule.withAllowedOrigins

withAllowedOrigins(allowedOrigins)

"A list of origin domains that will be allowed by CORS."

fn spec.forProvider.corsRule.withAllowedOriginsMixin

withAllowedOriginsMixin(allowedOrigins)

"A list of origin domains that will be allowed by CORS."

Note: This function appends passed data to existing values

fn spec.forProvider.corsRule.withExposedHeaders

withExposedHeaders(exposedHeaders)

"A list of response headers that are exposed to CORS clients."

fn spec.forProvider.corsRule.withExposedHeadersMixin

withExposedHeadersMixin(exposedHeaders)

"A list of response headers that are exposed to CORS clients."

Note: This function appends passed data to existing values

fn spec.forProvider.corsRule.withMaxAgeInSeconds

withMaxAgeInSeconds(maxAgeInSeconds)

"The number of seconds the client should cache a preflight response."

obj spec.forProvider.geoLocation

"Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location. Value is a geo_location block as defined below."

fn spec.forProvider.geoLocation.withFailoverPriority

withFailoverPriority(failoverPriority)

"The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0."

fn spec.forProvider.geoLocation.withLocation

withLocation(location)

"The name of the Azure region to host replicated data."

fn spec.forProvider.geoLocation.withZoneRedundant

withZoneRedundant(zoneRedundant)

"Should zone redundancy be enabled for this region? Defaults to false."

obj spec.forProvider.identity

"An identity block as defined below."

fn spec.forProvider.identity.withIdentityIds

withIdentityIds(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account."

fn spec.forProvider.identity.withIdentityIdsMixin

withIdentityIdsMixin(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cosmos Account."

Note: This function appends passed data to existing values

fn spec.forProvider.identity.withType

withType(type)

"The Type of Managed Identity assigned to this Cosmos account. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned."

obj spec.forProvider.resourceGroupNameRef

"Reference to a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.resourceGroupNameRef.policy

"Policies for referencing."

fn spec.forProvider.resourceGroupNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.resourceGroupNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.resourceGroupNameSelector

"Selector for a ResourceGroup in azure to populate resourceGroupName."

fn spec.forProvider.resourceGroupNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.resourceGroupNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.resourceGroupNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.resourceGroupNameSelector.policy

"Policies for selection."

fn spec.forProvider.resourceGroupNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.resourceGroupNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.restore

"A restore block as defined below."

fn spec.forProvider.restore.withDatabase

withDatabase(database)

"A database block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.restore.withDatabaseMixin

withDatabaseMixin(database)

"A database block as defined below. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.restore.withRestoreTimestampInUtc

withRestoreTimestampInUtc(restoreTimestampInUtc)

"The creation time of the database or the collection (Datetime Format RFC 3339). Changing this forces a new resource to be created."

fn spec.forProvider.restore.withSourceCosmosdbAccountId

withSourceCosmosdbAccountId(sourceCosmosdbAccountId)

"The resource ID of the restorable database account from which the restore has to be initiated. The example is /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}. Changing this forces a new resource to be created."

obj spec.forProvider.restore.database

"A database block as defined below. Changing this forces a new resource to be created."

fn spec.forProvider.restore.database.withCollectionNames

withCollectionNames(collectionNames)

"A list of the collection names for the restore request. Changing this forces a new resource to be created."

fn spec.forProvider.restore.database.withCollectionNamesMixin

withCollectionNamesMixin(collectionNames)

"A list of the collection names for the restore request. Changing this forces a new resource to be created."

Note: This function appends passed data to existing values

fn spec.forProvider.restore.database.withName

withName(name)

"Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created."

obj spec.forProvider.restore.sourceCosmosdbAccountIdRef

"Reference to a Account to populate sourceCosmosdbAccountId."

fn spec.forProvider.restore.sourceCosmosdbAccountIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.restore.sourceCosmosdbAccountIdRef.policy

"Policies for referencing."

fn spec.forProvider.restore.sourceCosmosdbAccountIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.restore.sourceCosmosdbAccountIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.restore.sourceCosmosdbAccountIdSelector

"Selector for a Account to populate sourceCosmosdbAccountId."

fn spec.forProvider.restore.sourceCosmosdbAccountIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.restore.sourceCosmosdbAccountIdSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.restore.sourceCosmosdbAccountIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.restore.sourceCosmosdbAccountIdSelector.policy

"Policies for selection."

fn spec.forProvider.restore.sourceCosmosdbAccountIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.restore.sourceCosmosdbAccountIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.virtualNetworkRule

"Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account."

fn spec.forProvider.virtualNetworkRule.withId

withId(id)

"The ID of the virtual network subnet."

fn spec.forProvider.virtualNetworkRule.withIgnoreMissingVnetServiceEndpoint

withIgnoreMissingVnetServiceEndpoint(ignoreMissingVnetServiceEndpoint)

"If set to true, the specified subnet will be added as a virtual network rule even if its CosmosDB service endpoint is not active. Defaults to false."

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.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

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.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

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

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

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

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

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

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."