labservices.v1beta1.labServiceLab
"LabServiceLab is the Schema for the LabServiceLabs API. Manages a Lab Service Lab."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
obj spec.forProvider
fn withAutoShutdown(autoShutdown)
fn withAutoShutdownMixin(autoShutdown)
fn withConnectionSetting(connectionSetting)
fn withConnectionSettingMixin(connectionSetting)
fn withDescription(description)
fn withLabPlanId(labPlanId)
fn withLocation(location)
fn withNetwork(network)
fn withNetworkMixin(network)
fn withResourceGroupName(resourceGroupName)
fn withRoster(roster)
fn withRosterMixin(roster)
fn withSecurity(security)
fn withSecurityMixin(security)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTitle(title)
fn withVirtualMachine(virtualMachine)
fn withVirtualMachineMixin(virtualMachine)
obj spec.forProvider.autoShutdown
obj spec.forProvider.connectionSetting
obj spec.forProvider.network
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.roster
obj spec.forProvider.security
obj spec.forProvider.virtualMachine
fn withAdditionalCapabilityGpuDriversInstalled(additionalCapabilityGpuDriversInstalled)
fn withAdminUser(adminUser)
fn withAdminUserMixin(adminUser)
fn withCreateOption(createOption)
fn withImageReference(imageReference)
fn withImageReferenceMixin(imageReference)
fn withNonAdminUser(nonAdminUser)
fn withNonAdminUserMixin(nonAdminUser)
fn withSharedPasswordEnabled(sharedPasswordEnabled)
fn withSku(sku)
fn withSkuMixin(sku)
fn withUsageQuota(usageQuota)
obj spec.forProvider.virtualMachine.adminUser
obj spec.forProvider.virtualMachine.imageReference
obj spec.forProvider.virtualMachine.nonAdminUser
obj spec.forProvider.virtualMachine.sku
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of LabServiceLab
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
"LabServiceLabSpec defines the desired state of LabServiceLab"
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.withAutoShutdown
withAutoShutdown(autoShutdown)
"An auto_shutdown block as defined below."
fn spec.forProvider.withAutoShutdownMixin
withAutoShutdownMixin(autoShutdown)
"An auto_shutdown block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withConnectionSetting
withConnectionSetting(connectionSetting)
"A connection_setting block as defined below."
fn spec.forProvider.withConnectionSettingMixin
withConnectionSettingMixin(connectionSetting)
"A connection_setting block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDescription
withDescription(description)
"The description of the Lab Service Lab."
fn spec.forProvider.withLabPlanId
withLabPlanId(labPlanId)
"The resource ID of the Lab Plan that is used during resource creation to provide defaults and acts as a permission container when creating a Lab Service Lab via labs.azure.com."
fn spec.forProvider.withLocation
withLocation(location)
"The Azure Region where the Lab Service Lab should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withNetwork
withNetwork(network)
"A network block as defined below."
fn spec.forProvider.withNetworkMixin
withNetworkMixin(network)
"A network block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the Resource Group where the Lab Service Lab should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withRoster
withRoster(roster)
"A roster block as defined below."
fn spec.forProvider.withRosterMixin
withRosterMixin(roster)
"A roster block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withSecurity
withSecurity(security)
"A security block as defined below."
fn spec.forProvider.withSecurityMixin
withSecurityMixin(security)
"A security block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withTags
withTags(tags)
"A mapping of tags which should be assigned to the Lab Service Lab."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A mapping of tags which should be assigned to the Lab Service Lab."
Note: This function appends passed data to existing values
fn spec.forProvider.withTitle
withTitle(title)
"The title of the Lab Service Lab."
fn spec.forProvider.withVirtualMachine
withVirtualMachine(virtualMachine)
"A virtual_machine block as defined below."
fn spec.forProvider.withVirtualMachineMixin
withVirtualMachineMixin(virtualMachine)
"A virtual_machine block as defined below."
Note: This function appends passed data to existing values
obj spec.forProvider.autoShutdown
"An auto_shutdown block as defined below."
fn spec.forProvider.autoShutdown.withDisconnectDelay
withDisconnectDelay(disconnectDelay)
"The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string."
fn spec.forProvider.autoShutdown.withIdleDelay
withIdleDelay(idleDelay)
"The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string."
fn spec.forProvider.autoShutdown.withNoConnectDelay
withNoConnectDelay(noConnectDelay)
"The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string."
fn spec.forProvider.autoShutdown.withShutdownOnIdle
withShutdownOnIdle(shutdownOnIdle)
"A VM will get shutdown when it has idled for a period of time. Possible values are LowUsage and UserAbsence."
obj spec.forProvider.connectionSetting
"A connection_setting block as defined below."
fn spec.forProvider.connectionSetting.withClientRdpAccess
withClientRdpAccess(clientRdpAccess)
"The enabled access level for Client Access over RDP. Possible value is Public."
fn spec.forProvider.connectionSetting.withClientSshAccess
withClientSshAccess(clientSshAccess)
"The enabled access level for Client Access over SSH. Possible value is Public."
obj spec.forProvider.network
"A network block as defined below."
fn spec.forProvider.network.withSubnetId
withSubnetId(subnetId)
"The resource ID of the Subnet for the network profile of the Lab Service Lab."
obj spec.forProvider.network.subnetIdRef
"Reference to a Subnet in network to populate subnetId."
fn spec.forProvider.network.subnetIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.network.subnetIdRef.policy
"Policies for referencing."
fn spec.forProvider.network.subnetIdRef.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.network.subnetIdRef.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.network.subnetIdSelector
"Selector for a Subnet in network to populate subnetId."
fn spec.forProvider.network.subnetIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.network.subnetIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.network.subnetIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.network.subnetIdSelector.policy
"Policies for selection."
fn spec.forProvider.network.subnetIdSelector.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.network.subnetIdSelector.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.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.roster
"A roster block as defined below."
fn spec.forProvider.roster.withActiveDirectoryGroupId
withActiveDirectoryGroupId(activeDirectoryGroupId)
"The AAD group ID which this Lab Service Lab roster is populated from."
fn spec.forProvider.roster.withLmsInstance
withLmsInstance(lmsInstance)
"The base URI identifying the lms instance."
fn spec.forProvider.roster.withLtiClientId
withLtiClientId(ltiClientId)
"The unique id of the Azure Lab Service tool in the lms."
fn spec.forProvider.roster.withLtiContextId
withLtiContextId(ltiContextId)
"The unique context identifier for the Lab Service Lab in the lms."
fn spec.forProvider.roster.withLtiRosterEndpoint
withLtiRosterEndpoint(ltiRosterEndpoint)
"The URI of the names and roles service endpoint on the lms for the class attached to this Lab Service Lab."
obj spec.forProvider.security
"A security block as defined below."
fn spec.forProvider.security.withOpenAccessEnabled
withOpenAccessEnabled(openAccessEnabled)
"Is open access enabled to allow any user or only specified users to register to a Lab Service Lab?"
obj spec.forProvider.virtualMachine
"A virtual_machine block as defined below."
fn spec.forProvider.virtualMachine.withAdditionalCapabilityGpuDriversInstalled
withAdditionalCapabilityGpuDriversInstalled(additionalCapabilityGpuDriversInstalled)
"Is flagged to pre-install dedicated GPU drivers? Defaults to false. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.withAdminUser
withAdminUser(adminUser)
"An admin_user block as defined below."
fn spec.forProvider.virtualMachine.withAdminUserMixin
withAdminUserMixin(adminUser)
"An admin_user block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.virtualMachine.withCreateOption
withCreateOption(createOption)
"The create option to indicate what Lab Service Lab VMs are created from. Possible values are Image and TemplateVM. Defaults to Image. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.withImageReference
withImageReference(imageReference)
"An image_reference block as defined below."
fn spec.forProvider.virtualMachine.withImageReferenceMixin
withImageReferenceMixin(imageReference)
"An image_reference block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.virtualMachine.withNonAdminUser
withNonAdminUser(nonAdminUser)
"A non_admin_user block as defined below."
fn spec.forProvider.virtualMachine.withNonAdminUserMixin
withNonAdminUserMixin(nonAdminUser)
"A non_admin_user block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.virtualMachine.withSharedPasswordEnabled
withSharedPasswordEnabled(sharedPasswordEnabled)
"Is the shared password enabled with the same password for all user VMs? Defaults to false. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.withSku
withSku(sku)
"A sku block as defined below."
fn spec.forProvider.virtualMachine.withSkuMixin
withSkuMixin(sku)
"A sku block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.virtualMachine.withUsageQuota
withUsageQuota(usageQuota)
"The initial quota allocated to each Lab Service Lab user. Defaults to PT0S. This value must be formatted as an ISO 8601 string."
obj spec.forProvider.virtualMachine.adminUser
"An admin_user block as defined below."
fn spec.forProvider.virtualMachine.adminUser.withUsername
withUsername(username)
"The username to use when signing in to Lab Service Lab VMs."
obj spec.forProvider.virtualMachine.adminUser.passwordSecretRef
"The password for the user."
fn spec.forProvider.virtualMachine.adminUser.passwordSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.virtualMachine.adminUser.passwordSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.virtualMachine.adminUser.passwordSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.virtualMachine.imageReference
"An image_reference block as defined below."
fn spec.forProvider.virtualMachine.imageReference.withId
withId(id)
"The resource ID of the image. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.imageReference.withOffer
withOffer(offer)
"The image offer if applicable. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.imageReference.withPublisher
withPublisher(publisher)
"The image publisher. Changing this forces a new resource to be created."
fn spec.forProvider.virtualMachine.imageReference.withSku
withSku(sku)
"A sku block as defined below."
fn spec.forProvider.virtualMachine.imageReference.withVersion
withVersion(version)
"The image version specified on creation. Changing this forces a new resource to be created."
obj spec.forProvider.virtualMachine.nonAdminUser
"A non_admin_user block as defined below."
fn spec.forProvider.virtualMachine.nonAdminUser.withUsername
withUsername(username)
"The username to use when signing in to Lab Service Lab VMs."
obj spec.forProvider.virtualMachine.nonAdminUser.passwordSecretRef
"The password for the user."
fn spec.forProvider.virtualMachine.nonAdminUser.passwordSecretRef.withKey
withKey(key)
"The key to select."
fn spec.forProvider.virtualMachine.nonAdminUser.passwordSecretRef.withName
withName(name)
"Name of the secret."
fn spec.forProvider.virtualMachine.nonAdminUser.passwordSecretRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."
obj spec.forProvider.virtualMachine.sku
"A sku block as defined below."
fn spec.forProvider.virtualMachine.sku.withCapacity
withCapacity(capacity)
"The capacity for the SKU. Possible values are between 0 and 400."
fn spec.forProvider.virtualMachine.sku.withName
withName(name)
"The name of the SKU. Changing this forces a new resource to be created."
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."