Skip to content

network.v1beta1.firewallPolicy

"FirewallPolicy is the Schema for the FirewallPolicys API. Manages a Firewall Policy."

Index

Fields

fn new

new(name)

new returns an instance of FirewallPolicy

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

"FirewallPolicySpec defines the desired state of FirewallPolicy"

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

withAutoLearnPrivateRangesEnabled(autoLearnPrivateRangesEnabled)

"Whether enable auto learn private ip range."

fn spec.forProvider.withBasePolicyId

withBasePolicyId(basePolicyId)

"The ID of the base Firewall Policy."

fn spec.forProvider.withDns

withDns(dns)

"A dns block as defined below."

fn spec.forProvider.withDnsMixin

withDnsMixin(dns)

"A dns block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withExplicitProxy

withExplicitProxy(explicitProxy)

"A explicit_proxy block as defined below."

fn spec.forProvider.withExplicitProxyMixin

withExplicitProxyMixin(explicitProxy)

"A explicit_proxy block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIdentity

withIdentity(identity)

"An identity block as defined below."

fn spec.forProvider.withIdentityMixin

withIdentityMixin(identity)

"An identity block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withInsights

withInsights(insights)

"An insights block as defined below."

fn spec.forProvider.withInsightsMixin

withInsightsMixin(insights)

"An insights block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withIntrusionDetection

withIntrusionDetection(intrusionDetection)

"A intrusion_detection block as defined below."

fn spec.forProvider.withIntrusionDetectionMixin

withIntrusionDetectionMixin(intrusionDetection)

"A intrusion_detection block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLocation

withLocation(location)

"The Azure Region where the Firewall Policy should exist. Changing this forces a new Firewall Policy to be created."

fn spec.forProvider.withPrivateIpRanges

withPrivateIpRanges(privateIpRanges)

"A list of private IP ranges to which traffic will not be SNAT."

fn spec.forProvider.withPrivateIpRangesMixin

withPrivateIpRangesMixin(privateIpRanges)

"A list of private IP ranges to which traffic will not be SNAT."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the Resource Group where the Firewall Policy should exist. Changing this forces a new Firewall Policy to be created."

fn spec.forProvider.withSku

withSku(sku)

"The SKU Tier of the Firewall Policy. Possible values are Standard, Premium and Basic. Changing this forces a new Firewall Policy to be created."

fn spec.forProvider.withSqlRedirectAllowed

withSqlRedirectAllowed(sqlRedirectAllowed)

"Whether SQL Redirect traffic filtering is allowed. Enabling this flag requires no rule using ports between 11000-11999."

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags which should be assigned to the Firewall Policy."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags which should be assigned to the Firewall Policy."

Note: This function appends passed data to existing values

fn spec.forProvider.withThreatIntelligenceAllowlist

withThreatIntelligenceAllowlist(threatIntelligenceAllowlist)

"A threat_intelligence_allowlist block as defined below."

fn spec.forProvider.withThreatIntelligenceAllowlistMixin

withThreatIntelligenceAllowlistMixin(threatIntelligenceAllowlist)

"A threat_intelligence_allowlist block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withThreatIntelligenceMode

withThreatIntelligenceMode(threatIntelligenceMode)

"The operation mode for Threat Intelligence. Possible values are Alert, Deny and Off. Defaults to Alert."

fn spec.forProvider.withTlsCertificate

withTlsCertificate(tlsCertificate)

"A tls_certificate block as defined below."

fn spec.forProvider.withTlsCertificateMixin

withTlsCertificateMixin(tlsCertificate)

"A tls_certificate block as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.dns

"A dns block as defined below."

fn spec.forProvider.dns.withProxyEnabled

withProxyEnabled(proxyEnabled)

"Whether to enable DNS proxy on Firewalls attached to this Firewall Policy? Defaults to false."

fn spec.forProvider.dns.withServers

withServers(servers)

"A list of custom DNS servers' IP addresses."

fn spec.forProvider.dns.withServersMixin

withServersMixin(servers)

"A list of custom DNS servers' IP addresses."

Note: This function appends passed data to existing values

obj spec.forProvider.explicitProxy

"A explicit_proxy block as defined below."

fn spec.forProvider.explicitProxy.withEnablePacFile

withEnablePacFile(enablePacFile)

"Whether the pac file port and url need to be provided."

fn spec.forProvider.explicitProxy.withEnabled

withEnabled(enabled)

"Whether the explicit proxy is enabled for this Firewall Policy."

fn spec.forProvider.explicitProxy.withHttpPort

withHttpPort(httpPort)

"The port number for explicit http protocol."

fn spec.forProvider.explicitProxy.withHttpsPort

withHttpsPort(httpsPort)

"The port number for explicit proxy https protocol."

fn spec.forProvider.explicitProxy.withPacFile

withPacFile(pacFile)

"Specifies a SAS URL for PAC file."

fn spec.forProvider.explicitProxy.withPacFilePort

withPacFilePort(pacFilePort)

"Specifies a port number for firewall to serve PAC file."

obj spec.forProvider.identity

"An identity block as defined below."

fn spec.forProvider.identity.withIdentityIds

withIdentityIds(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Firewall Policy."

fn spec.forProvider.identity.withIdentityIdsMixin

withIdentityIdsMixin(identityIds)

"Specifies a list of User Assigned Managed Identity IDs to be assigned to this Firewall Policy."

Note: This function appends passed data to existing values

fn spec.forProvider.identity.withType

withType(type)

"Specifies the type of Managed Service Identity that should be configured on this Firewall Policy. Only possible value is UserAssigned."

obj spec.forProvider.insights

"An insights block as defined below."

fn spec.forProvider.insights.withDefaultLogAnalyticsWorkspaceId

withDefaultLogAnalyticsWorkspaceId(defaultLogAnalyticsWorkspaceId)

"The ID of the default Log Analytics Workspace that the Firewalls associated with this Firewall Policy will send their logs to, when there is no location matches in the log_analytics_workspace."

fn spec.forProvider.insights.withEnabled

withEnabled(enabled)

"Whether the insights functionality is enabled for this Firewall Policy."

fn spec.forProvider.insights.withLogAnalyticsWorkspace

withLogAnalyticsWorkspace(logAnalyticsWorkspace)

"A list of log_analytics_workspace block as defined below."

fn spec.forProvider.insights.withLogAnalyticsWorkspaceMixin

withLogAnalyticsWorkspaceMixin(logAnalyticsWorkspace)

"A list of log_analytics_workspace block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.insights.withRetentionInDays

withRetentionInDays(retentionInDays)

"The log retention period in days."

obj spec.forProvider.insights.logAnalyticsWorkspace

"A list of log_analytics_workspace block as defined below."

fn spec.forProvider.insights.logAnalyticsWorkspace.withFirewallLocation

withFirewallLocation(firewallLocation)

"The location of the Firewalls, that when matches this Log Analytics Workspace will be used to consume their logs."

fn spec.forProvider.insights.logAnalyticsWorkspace.withId

withId(id)

"12-digit number (id) which identifies your signature."

obj spec.forProvider.intrusionDetection

"A intrusion_detection block as defined below."

fn spec.forProvider.intrusionDetection.withMode

withMode(mode)

"In which mode you want to run intrusion detection: Off, Alert or Deny."

fn spec.forProvider.intrusionDetection.withPrivateRanges

withPrivateRanges(privateRanges)

"A list of Private IP address ranges to identify traffic direction. By default, only ranges defined by IANA RFC 1918 are considered private IP addresses."

fn spec.forProvider.intrusionDetection.withPrivateRangesMixin

withPrivateRangesMixin(privateRanges)

"A list of Private IP address ranges to identify traffic direction. By default, only ranges defined by IANA RFC 1918 are considered private IP addresses."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.withSignatureOverrides

withSignatureOverrides(signatureOverrides)

"One or more signature_overrides blocks as defined below."

fn spec.forProvider.intrusionDetection.withSignatureOverridesMixin

withSignatureOverridesMixin(signatureOverrides)

"One or more signature_overrides blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.withTrafficBypass

withTrafficBypass(trafficBypass)

"One or more traffic_bypass blocks as defined below."

fn spec.forProvider.intrusionDetection.withTrafficBypassMixin

withTrafficBypassMixin(trafficBypass)

"One or more traffic_bypass blocks as defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.intrusionDetection.signatureOverrides

"One or more signature_overrides blocks as defined below."

fn spec.forProvider.intrusionDetection.signatureOverrides.withId

withId(id)

"12-digit number (id) which identifies your signature."

fn spec.forProvider.intrusionDetection.signatureOverrides.withState

withState(state)

"state can be any of Off, Alert or Deny."

obj spec.forProvider.intrusionDetection.trafficBypass

"One or more traffic_bypass blocks as defined below."

fn spec.forProvider.intrusionDetection.trafficBypass.withDescription

withDescription(description)

"The description for this bypass traffic setting."

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationAddresses

withDestinationAddresses(destinationAddresses)

"Specifies a list of destination IP addresses that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationAddressesMixin

withDestinationAddressesMixin(destinationAddresses)

"Specifies a list of destination IP addresses that shall be bypassed by intrusion detection."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationIpGroups

withDestinationIpGroups(destinationIpGroups)

"Specifies a list of destination IP groups that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationIpGroupsMixin

withDestinationIpGroupsMixin(destinationIpGroups)

"Specifies a list of destination IP groups that shall be bypassed by intrusion detection."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationPorts

withDestinationPorts(destinationPorts)

"Specifies a list of destination IP ports that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withDestinationPortsMixin

withDestinationPortsMixin(destinationPorts)

"Specifies a list of destination IP ports that shall be bypassed by intrusion detection."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.trafficBypass.withName

withName(name)

"The name which should be used for this bypass traffic setting."

fn spec.forProvider.intrusionDetection.trafficBypass.withProtocol

withProtocol(protocol)

"The protocols any of ANY, TCP, ICMP, UDP that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withSourceAddresses

withSourceAddresses(sourceAddresses)

"Specifies a list of source addresses that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withSourceAddressesMixin

withSourceAddressesMixin(sourceAddresses)

"Specifies a list of source addresses that shall be bypassed by intrusion detection."

Note: This function appends passed data to existing values

fn spec.forProvider.intrusionDetection.trafficBypass.withSourceIpGroups

withSourceIpGroups(sourceIpGroups)

"Specifies a list of source IP groups that shall be bypassed by intrusion detection."

fn spec.forProvider.intrusionDetection.trafficBypass.withSourceIpGroupsMixin

withSourceIpGroupsMixin(sourceIpGroups)

"Specifies a list of source IP groups that shall be bypassed by intrusion detection."

Note: This function appends passed data to existing values

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

"A threat_intelligence_allowlist block as defined below."

fn spec.forProvider.threatIntelligenceAllowlist.withFqdns

withFqdns(fqdns)

"A list of FQDNs that will be skipped for threat detection."

fn spec.forProvider.threatIntelligenceAllowlist.withFqdnsMixin

withFqdnsMixin(fqdns)

"A list of FQDNs that will be skipped for threat detection."

Note: This function appends passed data to existing values

fn spec.forProvider.threatIntelligenceAllowlist.withIpAddresses

withIpAddresses(ipAddresses)

"A list of IP addresses or CIDR ranges that will be skipped for threat detection."

fn spec.forProvider.threatIntelligenceAllowlist.withIpAddressesMixin

withIpAddressesMixin(ipAddresses)

"A list of IP addresses or CIDR ranges that will be skipped for threat detection."

Note: This function appends passed data to existing values

obj spec.forProvider.tlsCertificate

"A tls_certificate block as defined below."

fn spec.forProvider.tlsCertificate.withKeyVaultSecretId

withKeyVaultSecretId(keyVaultSecretId)

"The ID of the Key Vault, where the secret or certificate is stored."

fn spec.forProvider.tlsCertificate.withName

withName(name)

"The name of the certificate."

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