compute.v1beta1.managedDisk
"ManagedDisk is the Schema for the ManagedDisks API. Manages a Managed Disk."
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 withCreateOption(createOption)
fn withDiskAccessId(diskAccessId)
fn withDiskEncryptionSetId(diskEncryptionSetId)
fn withDiskIopsReadOnly(diskIopsReadOnly)
fn withDiskIopsReadWrite(diskIopsReadWrite)
fn withDiskMbpsReadOnly(diskMbpsReadOnly)
fn withDiskMbpsReadWrite(diskMbpsReadWrite)
fn withDiskSizeGb(diskSizeGb)
fn withEdgeZone(edgeZone)
fn withEncryptionSettings(encryptionSettings)
fn withEncryptionSettingsMixin(encryptionSettings)
fn withGalleryImageReferenceId(galleryImageReferenceId)
fn withHyperVGeneration(hyperVGeneration)
fn withImageReferenceId(imageReferenceId)
fn withLocation(location)
fn withLogicalSectorSize(logicalSectorSize)
fn withMaxShares(maxShares)
fn withNetworkAccessPolicy(networkAccessPolicy)
fn withOnDemandBurstingEnabled(onDemandBurstingEnabled)
fn withOsType(osType)
fn withPublicNetworkAccessEnabled(publicNetworkAccessEnabled)
fn withResourceGroupName(resourceGroupName)
fn withSecureVmDiskEncryptionSetId(secureVmDiskEncryptionSetId)
fn withSecurityType(securityType)
fn withSourceResourceId(sourceResourceId)
fn withSourceUri(sourceUri)
fn withStorageAccountId(storageAccountId)
fn withStorageAccountType(storageAccountType)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTier(tier)
fn withTrustedLaunchEnabled(trustedLaunchEnabled)
fn withUploadSizeBytes(uploadSizeBytes)
fn withZone(zone)
obj spec.forProvider.encryptionSettings
fn withDiskEncryptionKey(diskEncryptionKey)
fn withDiskEncryptionKeyMixin(diskEncryptionKey)
fn withEnabled(enabled)
fn withKeyEncryptionKey(keyEncryptionKey)
fn withKeyEncryptionKeyMixin(keyEncryptionKey)
obj spec.forProvider.encryptionSettings.diskEncryptionKey
obj spec.forProvider.encryptionSettings.keyEncryptionKey
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.sourceResourceIdRef
obj spec.forProvider.sourceResourceIdSelector
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of ManagedDisk
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
"ManagedDiskSpec defines the desired state of ManagedDisk"
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.withCreateOption
withCreateOption(createOption)
"The method to use when creating the managed disk. Changing this forces a new resource to be created. Possible values include:"
fn spec.forProvider.withDiskAccessId
withDiskAccessId(diskAccessId)
"The ID of the disk access resource for using private endpoints on disks."
fn spec.forProvider.withDiskEncryptionSetId
withDiskEncryptionSetId(diskEncryptionSetId)
"The ID of a Disk Encryption Set which should be used to encrypt this Managed Disk. Conflicts with secure_vm_disk_encryption_set_id."
fn spec.forProvider.withDiskIopsReadOnly
withDiskIopsReadOnly(diskIopsReadOnly)
"The number of IOPS allowed across all VMs mounting the shared disk as read-only; only settable for UltraSSD disks and PremiumV2 disks with shared disk enabled. One operation can transfer between 4k and 256k bytes."
fn spec.forProvider.withDiskIopsReadWrite
withDiskIopsReadWrite(diskIopsReadWrite)
"The number of IOPS allowed for this disk; only settable for UltraSSD disks and PremiumV2 disks. One operation can transfer between 4k and 256k bytes."
fn spec.forProvider.withDiskMbpsReadOnly
withDiskMbpsReadOnly(diskMbpsReadOnly)
"The bandwidth allowed across all VMs mounting the shared disk as read-only; only settable for UltraSSD disks and PremiumV2 disks with shared disk enabled. MBps means millions of bytes per second."
fn spec.forProvider.withDiskMbpsReadWrite
withDiskMbpsReadWrite(diskMbpsReadWrite)
"The bandwidth allowed for this disk; only settable for UltraSSD disks and PremiumV2 disks. MBps means millions of bytes per second."
fn spec.forProvider.withDiskSizeGb
withDiskSizeGb(diskSizeGb)
"Specifies the size of the managed disk to create in gigabytes. If create_option is Copy or FromImage, then the value must be equal to or greater than the source's size. The size can only be increased."
fn spec.forProvider.withEdgeZone
withEdgeZone(edgeZone)
"Specifies the Edge Zone within the Azure Region where this Managed Disk should exist. Changing this forces a new Managed Disk to be created."
fn spec.forProvider.withEncryptionSettings
withEncryptionSettings(encryptionSettings)
"A encryption_settings block as defined below."
fn spec.forProvider.withEncryptionSettingsMixin
withEncryptionSettingsMixin(encryptionSettings)
"A encryption_settings block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withGalleryImageReferenceId
withGalleryImageReferenceId(galleryImageReferenceId)
"ID of a Gallery Image Version to copy when create_option is FromImage. This field cannot be specified if image_reference_id is specified. Changing this forces a new resource to be created."
fn spec.forProvider.withHyperVGeneration
withHyperVGeneration(hyperVGeneration)
"The HyperV Generation of the Disk when the source of an Import or Copy operation targets a source that contains an operating system. Possible values are V1 and V2. For ImportSecure it must be set to V2. Changing this forces a new resource to be created."
fn spec.forProvider.withImageReferenceId
withImageReferenceId(imageReferenceId)
"ID of an existing platform/marketplace disk image to copy when create_option is FromImage. This field cannot be specified if gallery_image_reference_id is specified. Changing this forces a new resource to be created."
fn spec.forProvider.withLocation
withLocation(location)
"Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created."
fn spec.forProvider.withLogicalSectorSize
withLogicalSectorSize(logicalSectorSize)
"Logical Sector Size. Possible values are: 512 and 4096. Defaults to 4096. Changing this forces a new resource to be created."
fn spec.forProvider.withMaxShares
withMaxShares(maxShares)
"The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time."
fn spec.forProvider.withNetworkAccessPolicy
withNetworkAccessPolicy(networkAccessPolicy)
"Policy for accessing the disk via network. Allowed values are AllowAll, AllowPrivate, and DenyAll."
fn spec.forProvider.withOnDemandBurstingEnabled
withOnDemandBurstingEnabled(onDemandBurstingEnabled)
"Specifies if On-Demand Bursting is enabled for the Managed Disk."
fn spec.forProvider.withOsType
withOsType(osType)
"Specify a value when the source of an Import, ImportSecure or Copy operation targets a source that contains an operating system. Valid values are Linux or Windows."
fn spec.forProvider.withPublicNetworkAccessEnabled
withPublicNetworkAccessEnabled(publicNetworkAccessEnabled)
"Whether it is allowed to access the disk via public network. Defaults to true."
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"The name of the Resource Group where the Managed Disk should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withSecureVmDiskEncryptionSetId
withSecureVmDiskEncryptionSetId(secureVmDiskEncryptionSetId)
"The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with disk_encryption_set_id. Changing this forces a new resource to be created."
fn spec.forProvider.withSecurityType
withSecurityType(securityType)
"Security Type of the Managed Disk when it is used for a Confidential VM. Possible values are ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey, ConfidentialVM_DiskEncryptedWithPlatformKey and ConfidentialVM_DiskEncryptedWithCustomerKey. Changing this forces a new resource to be created."
fn spec.forProvider.withSourceResourceId
withSourceResourceId(sourceResourceId)
"The ID of an existing Managed Disk or Snapshot to copy when create_option is Copy or the recovery point to restore when create_option is Restore. Changing this forces a new resource to be created."
fn spec.forProvider.withSourceUri
withSourceUri(sourceUri)
"URI to a valid VHD file to be used when create_option is Import or ImportSecure. Changing this forces a new resource to be created."
fn spec.forProvider.withStorageAccountId
withStorageAccountId(storageAccountId)
"The ID of the Storage Account where the source_uri is located. Required when create_option is set to Import or ImportSecure. Changing this forces a new resource to be created."
fn spec.forProvider.withStorageAccountType
withStorageAccountType(storageAccountType)
"The type of storage to use for the managed disk. Possible values are Standard_LRS, StandardSSD_ZRS, Premium_LRS, PremiumV2_LRS, Premium_ZRS, StandardSSD_LRS or UltraSSD_LRS."
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.withTier
withTier(tier)
"The disk performance tier to use. Possible values are documented here. This feature is currently supported only for premium SSDs."
fn spec.forProvider.withTrustedLaunchEnabled
withTrustedLaunchEnabled(trustedLaunchEnabled)
"Specifies if Trusted Launch is enabled for the Managed Disk. Changing this forces a new resource to be created."
fn spec.forProvider.withUploadSizeBytes
withUploadSizeBytes(uploadSizeBytes)
"Specifies the size of the managed disk to create in bytes. Required when create_option is Upload. The value must be equal to the source disk to be copied in bytes. Source disk size could be calculated with ls -l or wc -c. More information can be found at Copy a managed disk. Changing this forces a new resource to be created."
fn spec.forProvider.withZone
withZone(zone)
"Specifies the Availability Zone in which this Managed Disk should be located. Changing this property forces a new resource to be created."
obj spec.forProvider.encryptionSettings
"A encryption_settings block as defined below."
fn spec.forProvider.encryptionSettings.withDiskEncryptionKey
withDiskEncryptionKey(diskEncryptionKey)
"A disk_encryption_key block as defined above."
fn spec.forProvider.encryptionSettings.withDiskEncryptionKeyMixin
withDiskEncryptionKeyMixin(diskEncryptionKey)
"A disk_encryption_key block as defined above."
Note: This function appends passed data to existing values
fn spec.forProvider.encryptionSettings.withEnabled
withEnabled(enabled)
fn spec.forProvider.encryptionSettings.withKeyEncryptionKey
withKeyEncryptionKey(keyEncryptionKey)
"A key_encryption_key block as defined below."
fn spec.forProvider.encryptionSettings.withKeyEncryptionKeyMixin
withKeyEncryptionKeyMixin(keyEncryptionKey)
"A key_encryption_key block as defined below."
Note: This function appends passed data to existing values
obj spec.forProvider.encryptionSettings.diskEncryptionKey
"A disk_encryption_key block as defined above."
fn spec.forProvider.encryptionSettings.diskEncryptionKey.withSecretUrl
withSecretUrl(secretUrl)
"The URL to the Key Vault Secret used as the Disk Encryption Key. This can be found as id on the azurerm_key_vault_secret resource."
fn spec.forProvider.encryptionSettings.diskEncryptionKey.withSourceVaultId
withSourceVaultId(sourceVaultId)
"The ID of the source Key Vault. This can be found as id on the azurerm_key_vault resource."
obj spec.forProvider.encryptionSettings.keyEncryptionKey
"A key_encryption_key block as defined below."
fn spec.forProvider.encryptionSettings.keyEncryptionKey.withKeyUrl
withKeyUrl(keyUrl)
"The URL to the Key Vault Key used as the Key Encryption Key. This can be found as id on the azurerm_key_vault_key resource."
fn spec.forProvider.encryptionSettings.keyEncryptionKey.withSourceVaultId
withSourceVaultId(sourceVaultId)
"The ID of the source Key Vault. This can be found as id on the azurerm_key_vault resource."
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.sourceResourceIdRef
"Reference to a ManagedDisk in compute to populate sourceResourceId."
fn spec.forProvider.sourceResourceIdRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.sourceResourceIdRef.policy
"Policies for referencing."
fn spec.forProvider.sourceResourceIdRef.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.sourceResourceIdRef.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.sourceResourceIdSelector
"Selector for a ManagedDisk in compute to populate sourceResourceId."
fn spec.forProvider.sourceResourceIdSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.sourceResourceIdSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.sourceResourceIdSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.sourceResourceIdSelector.policy
"Policies for selection."
fn spec.forProvider.sourceResourceIdSelector.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.sourceResourceIdSelector.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.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."