Skip to content

network.v1beta1.frontDoor

"FrontDoor is the Schema for the FrontDoors API. Manages an Azure Front Door (classic) instance."

Index

Fields

fn new

new(name)

new returns an instance of FrontDoor

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

"FrontDoorSpec defines the desired state of FrontDoor"

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

withBackendPool(backendPool)

"A backend_pool block as defined below."

fn spec.forProvider.withBackendPoolHealthProbe

withBackendPoolHealthProbe(backendPoolHealthProbe)

"A backend_pool_health_probe block as defined below."

fn spec.forProvider.withBackendPoolHealthProbeMixin

withBackendPoolHealthProbeMixin(backendPoolHealthProbe)

"A backend_pool_health_probe block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withBackendPoolLoadBalancing

withBackendPoolLoadBalancing(backendPoolLoadBalancing)

"A backend_pool_load_balancing block as defined below."

fn spec.forProvider.withBackendPoolLoadBalancingMixin

withBackendPoolLoadBalancingMixin(backendPoolLoadBalancing)

"A backend_pool_load_balancing block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withBackendPoolMixin

withBackendPoolMixin(backendPool)

"A backend_pool block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withBackendPoolSettings

withBackendPoolSettings(backendPoolSettings)

"A backend_pool_settings block as defined below."

fn spec.forProvider.withBackendPoolSettingsMixin

withBackendPoolSettingsMixin(backendPoolSettings)

"A backend_pool_settings block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withFriendlyName

withFriendlyName(friendlyName)

"A friendly name for the Front Door service."

fn spec.forProvider.withFrontendEndpoint

withFrontendEndpoint(frontendEndpoint)

"A frontend_endpoint block as defined below."

fn spec.forProvider.withFrontendEndpointMixin

withFrontendEndpointMixin(frontendEndpoint)

"A frontend_endpoint block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLoadBalancerEnabled

withLoadBalancerEnabled(loadBalancerEnabled)

"Should the Front Door Load Balancer be Enabled? Defaults to true."

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"Specifies the name of the Resource Group in which the Front Door service should exist. Changing this forces a new resource to be created."

fn spec.forProvider.withRoutingRule

withRoutingRule(routingRule)

"A routing_rule block as defined below."

fn spec.forProvider.withRoutingRuleMixin

withRoutingRuleMixin(routingRule)

"A routing_rule 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

obj spec.forProvider.backendPool

"A backend_pool block as defined below."

fn spec.forProvider.backendPool.withBackend

withBackend(backend)

"A backend block as defined below."

fn spec.forProvider.backendPool.withBackendMixin

withBackendMixin(backend)

"A backend block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.backendPool.withHealthProbeName

withHealthProbeName(healthProbeName)

"Specifies the name of the backend_pool_health_probe block within this resource to use for this Backend Pool."

fn spec.forProvider.backendPool.withLoadBalancingName

withLoadBalancingName(loadBalancingName)

"Specifies the name of the backend_pool_load_balancing block within this resource to use for this Backend Pool."

fn spec.forProvider.backendPool.withName

withName(name)

"Specifies the name of the Backend Pool."

obj spec.forProvider.backendPool.backend

"A backend block as defined below."

fn spec.forProvider.backendPool.backend.withAddress

withAddress(address)

"Location of the backend (IP address or FQDN)"

fn spec.forProvider.backendPool.backend.withEnabled

withEnabled(enabled)

"Enable or Disable use of this Backend Routing Rule. Permitted values are true or false. Defaults to true."

fn spec.forProvider.backendPool.backend.withHostHeader

withHostHeader(hostHeader)

"The value to use as the host header sent to the backend."

fn spec.forProvider.backendPool.backend.withHttpPort

withHttpPort(httpPort)

"The HTTP TCP port number. Possible values are between 1 - 65535."

fn spec.forProvider.backendPool.backend.withHttpsPort

withHttpsPort(httpsPort)

"The HTTPS TCP port number. Possible values are between 1 - 65535."

fn spec.forProvider.backendPool.backend.withPriority

withPriority(priority)

"Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. Defaults to 1."

fn spec.forProvider.backendPool.backend.withWeight

withWeight(weight)

"Weight of this endpoint for load balancing purposes. Defaults to 50."

obj spec.forProvider.backendPoolHealthProbe

"A backend_pool_health_probe block as defined below."

fn spec.forProvider.backendPoolHealthProbe.withEnabled

withEnabled(enabled)

"Is this health probe enabled? Defaults to true."

fn spec.forProvider.backendPoolHealthProbe.withIntervalInSeconds

withIntervalInSeconds(intervalInSeconds)

"The number of seconds between each Health Probe. Defaults to 120."

fn spec.forProvider.backendPoolHealthProbe.withName

withName(name)

"Specifies the name of the Health Probe."

fn spec.forProvider.backendPoolHealthProbe.withPath

withPath(path)

"The path to use for the Health Probe. Default is /."

fn spec.forProvider.backendPoolHealthProbe.withProbeMethod

withProbeMethod(probeMethod)

"Specifies HTTP method the health probe uses when querying the backend pool instances. Possible values include: Get and Head. Defaults to GET."

fn spec.forProvider.backendPoolHealthProbe.withProtocol

withProtocol(protocol)

"Protocol scheme to use for the Health Probe. Possible values are Http and Https. Defaults to Http."

obj spec.forProvider.backendPoolLoadBalancing

"A backend_pool_load_balancing block as defined below."

fn spec.forProvider.backendPoolLoadBalancing.withAdditionalLatencyMilliseconds

withAdditionalLatencyMilliseconds(additionalLatencyMilliseconds)

"The additional latency in milliseconds for probes to fall into the lowest latency bucket. Defaults to 0."

fn spec.forProvider.backendPoolLoadBalancing.withName

withName(name)

"Specifies the name of the Load Balancer."

fn spec.forProvider.backendPoolLoadBalancing.withSampleSize

withSampleSize(sampleSize)

"The number of samples to consider for load balancing decisions. Defaults to 4."

fn spec.forProvider.backendPoolLoadBalancing.withSuccessfulSamplesRequired

withSuccessfulSamplesRequired(successfulSamplesRequired)

"The number of samples within the sample period that must succeed. Defaults to 2."

obj spec.forProvider.backendPoolSettings

"A backend_pool_settings block as defined below."

fn spec.forProvider.backendPoolSettings.withBackendPoolsSendReceiveTimeoutSeconds

withBackendPoolsSendReceiveTimeoutSeconds(backendPoolsSendReceiveTimeoutSeconds)

"Specifies the send and receive timeout on forwarding request to the backend. When the timeout is reached, the request fails and returns. Possible values are between 0 - 240. Defaults to 60."

fn spec.forProvider.backendPoolSettings.withEnforceBackendPoolsCertificateNameCheck

withEnforceBackendPoolsCertificateNameCheck(enforceBackendPoolsCertificateNameCheck)

"Enforce certificate name check on HTTPS requests to all backend pools, this setting will have no effect on HTTP requests. Permitted values are true or false."

obj spec.forProvider.frontendEndpoint

"A frontend_endpoint block as defined below."

fn spec.forProvider.frontendEndpoint.withHostName

withHostName(hostName)

"Specifies the host name of the frontend_endpoint. Must be a domain name. In order to use a name.azurefd.net domain, the name value must match the Front Door name."

fn spec.forProvider.frontendEndpoint.withName

withName(name)

"Specifies the name of the frontend_endpoint."

fn spec.forProvider.frontendEndpoint.withSessionAffinityEnabled

withSessionAffinityEnabled(sessionAffinityEnabled)

"Whether to allow session affinity on this host. Valid options are true or false Defaults to false."

fn spec.forProvider.frontendEndpoint.withSessionAffinityTtlSeconds

withSessionAffinityTtlSeconds(sessionAffinityTtlSeconds)

"The TTL to use in seconds for session affinity, if applicable. Defaults to 0."

fn spec.forProvider.frontendEndpoint.withWebApplicationFirewallPolicyLinkId

withWebApplicationFirewallPolicyLinkId(webApplicationFirewallPolicyLinkId)

"Defines the Web Application Firewall policy ID for each host."

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

"A routing_rule block as defined below."

fn spec.forProvider.routingRule.withAcceptedProtocols

withAcceptedProtocols(acceptedProtocols)

"Protocol schemes to match for the Backend Routing Rule. Possible values are Http and Https."

fn spec.forProvider.routingRule.withAcceptedProtocolsMixin

withAcceptedProtocolsMixin(acceptedProtocols)

"Protocol schemes to match for the Backend Routing Rule. Possible values are Http and Https."

Note: This function appends passed data to existing values

fn spec.forProvider.routingRule.withEnabled

withEnabled(enabled)

"Enable or Disable use of this Backend Routing Rule. Permitted values are true or false. Defaults to true."

fn spec.forProvider.routingRule.withForwardingConfiguration

withForwardingConfiguration(forwardingConfiguration)

"A forwarding_configuration block as defined below."

fn spec.forProvider.routingRule.withForwardingConfigurationMixin

withForwardingConfigurationMixin(forwardingConfiguration)

"A forwarding_configuration block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.routingRule.withFrontendEndpoints

withFrontendEndpoints(frontendEndpoints)

"The names of the frontend_endpoint blocks within this resource to associate with this routing_rule."

fn spec.forProvider.routingRule.withFrontendEndpointsMixin

withFrontendEndpointsMixin(frontendEndpoints)

"The names of the frontend_endpoint blocks within this resource to associate with this routing_rule."

Note: This function appends passed data to existing values

fn spec.forProvider.routingRule.withName

withName(name)

"Specifies the name of the Routing Rule."

fn spec.forProvider.routingRule.withPatternsToMatch

withPatternsToMatch(patternsToMatch)

"The route patterns for the Backend Routing Rule."

fn spec.forProvider.routingRule.withPatternsToMatchMixin

withPatternsToMatchMixin(patternsToMatch)

"The route patterns for the Backend Routing Rule."

Note: This function appends passed data to existing values

fn spec.forProvider.routingRule.withRedirectConfiguration

withRedirectConfiguration(redirectConfiguration)

"A redirect_configuration block as defined below."

fn spec.forProvider.routingRule.withRedirectConfigurationMixin

withRedirectConfigurationMixin(redirectConfiguration)

"A redirect_configuration block as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.routingRule.forwardingConfiguration

"A forwarding_configuration block as defined below."

fn spec.forProvider.routingRule.forwardingConfiguration.withBackendPoolName

withBackendPoolName(backendPoolName)

"Specifies the name of the Backend Pool to forward the incoming traffic to."

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheDuration

withCacheDuration(cacheDuration)

"Specify the caching duration (in ISO8601 notation e.g. P1DT2H for 1 day and 2 hours). Needs to be greater than 0 and smaller than 365 days. cache_duration works only in combination with cache_enabled set to true."

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheEnabled

withCacheEnabled(cacheEnabled)

"Specifies whether to Enable caching or not. Valid options are true or false. Defaults to false."

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheQueryParameterStripDirective

withCacheQueryParameterStripDirective(cacheQueryParameterStripDirective)

"Defines cache behaviour in relation to query string parameters. Valid options are StripAll, StripAllExcept, StripOnly or StripNone. Defaults to StripAll."

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheQueryParameters

withCacheQueryParameters(cacheQueryParameters)

"Specify query parameters (array). Works only in combination with cache_query_parameter_strip_directive set to StripAllExcept or StripOnly."

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheQueryParametersMixin

withCacheQueryParametersMixin(cacheQueryParameters)

"Specify query parameters (array). Works only in combination with cache_query_parameter_strip_directive set to StripAllExcept or StripOnly."

Note: This function appends passed data to existing values

fn spec.forProvider.routingRule.forwardingConfiguration.withCacheUseDynamicCompression

withCacheUseDynamicCompression(cacheUseDynamicCompression)

"Whether to use dynamic compression when caching. Valid options are true or false. Defaults to false."

fn spec.forProvider.routingRule.forwardingConfiguration.withCustomForwardingPath

withCustomForwardingPath(customForwardingPath)

"Path to use when constructing the request to forward to the backend. This functions as a URL Rewrite. Default behaviour preserves the URL path."

fn spec.forProvider.routingRule.forwardingConfiguration.withForwardingProtocol

withForwardingProtocol(forwardingProtocol)

"Protocol to use when redirecting. Valid options are HttpOnly, HttpsOnly, or MatchRequest. Defaults to HttpsOnly."

obj spec.forProvider.routingRule.redirectConfiguration

"A redirect_configuration block as defined below."

fn spec.forProvider.routingRule.redirectConfiguration.withCustomFragment

withCustomFragment(customFragment)

"The destination fragment in the portion of URL after '#'. Set this to add a fragment to the redirect URL."

fn spec.forProvider.routingRule.redirectConfiguration.withCustomHost

withCustomHost(customHost)

"Set this to change the URL for the redirection."

fn spec.forProvider.routingRule.redirectConfiguration.withCustomPath

withCustomPath(customPath)

"The path to retain as per the incoming request, or update in the URL for the redirection."

fn spec.forProvider.routingRule.redirectConfiguration.withCustomQueryString

withCustomQueryString(customQueryString)

"Replace any existing query string from the incoming request URL."

fn spec.forProvider.routingRule.redirectConfiguration.withRedirectProtocol

withRedirectProtocol(redirectProtocol)

"Protocol to use when redirecting. Valid options are HttpOnly, HttpsOnly, or MatchRequest."

fn spec.forProvider.routingRule.redirectConfiguration.withRedirectType

withRedirectType(redirectType)

"Status code for the redirect. Valida options are Moved, Found, TemporaryRedirect, PermanentRedirect."

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