Skip to content

network.v1beta1.webApplicationFirewallPolicy

"WebApplicationFirewallPolicy is the Schema for the WebApplicationFirewallPolicys API. Manages a Azure Web Application Firewall Policy instance."

Index

Fields

fn new

new(name)

new returns an instance of WebApplicationFirewallPolicy

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

"WebApplicationFirewallPolicySpec defines the desired state of WebApplicationFirewallPolicy"

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

withCustomRules(customRules)

"One or more custom_rules blocks as defined below."

fn spec.forProvider.withCustomRulesMixin

withCustomRulesMixin(customRules)

"One or more custom_rules blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLocation

withLocation(location)

"Resource location. Changing this forces a new resource to be created."

fn spec.forProvider.withManagedRules

withManagedRules(managedRules)

"A managed_rules blocks as defined below."

fn spec.forProvider.withManagedRulesMixin

withManagedRulesMixin(managedRules)

"A managed_rules blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPolicySettings

withPolicySettings(policySettings)

"A policy_settings block as defined below."

fn spec.forProvider.withPolicySettingsMixin

withPolicySettingsMixin(policySettings)

"A policy_settings block as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.withResourceGroupName

withResourceGroupName(resourceGroupName)

"The name of the resource group. Changing this forces a new resource to be created."

fn spec.forProvider.withTags

withTags(tags)

"A mapping of tags to assign to the Web Application Firewall Policy."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A mapping of tags to assign to the Web Application Firewall Policy."

Note: This function appends passed data to existing values

obj spec.forProvider.customRules

"One or more custom_rules blocks as defined below."

fn spec.forProvider.customRules.withAction

withAction(action)

"Type of action. Possible values are Allow, Block and Log."

fn spec.forProvider.customRules.withMatchConditions

withMatchConditions(matchConditions)

"One or more match_conditions blocks as defined below."

fn spec.forProvider.customRules.withMatchConditionsMixin

withMatchConditionsMixin(matchConditions)

"One or more match_conditions blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.customRules.withName

withName(name)

"Gets name of the resource that is unique within a policy. This name can be used to access the resource."

fn spec.forProvider.customRules.withPriority

withPriority(priority)

"Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value."

fn spec.forProvider.customRules.withRuleType

withRuleType(ruleType)

"Describes the type of rule. Possible values are MatchRule and Invalid."

obj spec.forProvider.customRules.matchConditions

"One or more match_conditions blocks as defined below."

fn spec.forProvider.customRules.matchConditions.withMatchValues

withMatchValues(matchValues)

"A list of match values."

fn spec.forProvider.customRules.matchConditions.withMatchValuesMixin

withMatchValuesMixin(matchValues)

"A list of match values."

Note: This function appends passed data to existing values

fn spec.forProvider.customRules.matchConditions.withMatchVariables

withMatchVariables(matchVariables)

"One or more match_variables blocks as defined below."

fn spec.forProvider.customRules.matchConditions.withMatchVariablesMixin

withMatchVariablesMixin(matchVariables)

"One or more match_variables blocks as defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.customRules.matchConditions.withNegationCondition

withNegationCondition(negationCondition)

"Describes if this is negate condition or not"

fn spec.forProvider.customRules.matchConditions.withOperator

withOperator(operator)

"Describes operator to be matched. Possible values are IPMatch, GeoMatch, Equal, Contains, LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, BeginsWith, EndsWith and Regex."

fn spec.forProvider.customRules.matchConditions.withTransforms

withTransforms(transforms)

"A list of transformations to do before the match is attempted. Possible values are HtmlEntityDecode, Lowercase, RemoveNulls, Trim, UrlDecode and UrlEncode."

fn spec.forProvider.customRules.matchConditions.withTransformsMixin

withTransformsMixin(transforms)

"A list of transformations to do before the match is attempted. Possible values are HtmlEntityDecode, Lowercase, RemoveNulls, Trim, UrlDecode and UrlEncode."

Note: This function appends passed data to existing values

obj spec.forProvider.customRules.matchConditions.matchVariables

"One or more match_variables blocks as defined below."

fn spec.forProvider.customRules.matchConditions.matchVariables.withSelector

withSelector(selector)

"Describes field of the matchVariable collection"

fn spec.forProvider.customRules.matchConditions.matchVariables.withVariableName

withVariableName(variableName)

"The name of the Match Variable. Possible values are RemoteAddr, RequestMethod, QueryString, PostArgs, RequestUri, RequestHeaders, RequestBody and RequestCookies."

obj spec.forProvider.managedRules

"A managed_rules blocks as defined below."

fn spec.forProvider.managedRules.withExclusion

withExclusion(exclusion)

"One or more exclusion block defined below."

fn spec.forProvider.managedRules.withExclusionMixin

withExclusionMixin(exclusion)

"One or more exclusion block defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.withManagedRuleSet

withManagedRuleSet(managedRuleSet)

"One or more managed_rule_set block defined below."

fn spec.forProvider.managedRules.withManagedRuleSetMixin

withManagedRuleSetMixin(managedRuleSet)

"One or more managed_rule_set block defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.managedRules.exclusion

"One or more exclusion block defined below."

fn spec.forProvider.managedRules.exclusion.withExcludedRuleSet

withExcludedRuleSet(excludedRuleSet)

"One or more excluded_rule_set block defined below."

fn spec.forProvider.managedRules.exclusion.withExcludedRuleSetMixin

withExcludedRuleSetMixin(excludedRuleSet)

"One or more excluded_rule_set block defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.exclusion.withMatchVariable

withMatchVariable(matchVariable)

"The name of the Match Variable. Possible values: RequestArgKeys, RequestArgNames, RequestArgValues, RequestCookieKeys, RequestCookieNames, RequestCookieValues, RequestHeaderKeys, RequestHeaderNames, RequestHeaderValues."

fn spec.forProvider.managedRules.exclusion.withSelector

withSelector(selector)

"Describes field of the matchVariable collection"

fn spec.forProvider.managedRules.exclusion.withSelectorMatchOperator

withSelectorMatchOperator(selectorMatchOperator)

"Describes operator to be matched. Possible values: Contains, EndsWith, Equals, EqualsAny, StartsWith."

obj spec.forProvider.managedRules.exclusion.excludedRuleSet

"One or more excluded_rule_set block defined below."

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.withRuleGroup

withRuleGroup(ruleGroup)

"One or more rule_group block defined below."

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.withRuleGroupMixin

withRuleGroupMixin(ruleGroup)

"One or more rule_group block defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.withType

withType(type)

"The rule set type. Possible values: Microsoft_BotManagerRuleSet and OWASP."

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.withVersion

withVersion(version)

"The rule set version. Possible values: 0.1, 1.0, 2.2.9, 3.0, 3.1 and 3.2."

obj spec.forProvider.managedRules.exclusion.excludedRuleSet.ruleGroup

"One or more rule_group block defined below."

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.ruleGroup.withExcludedRules

withExcludedRules(excludedRules)

"One or more Rule IDs for exclusion."

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.ruleGroup.withExcludedRulesMixin

withExcludedRulesMixin(excludedRules)

"One or more Rule IDs for exclusion."

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.exclusion.excludedRuleSet.ruleGroup.withRuleGroupName

withRuleGroupName(ruleGroupName)

"The name of the Rule Group. Possible values are BadBots, crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, GoodBots, Known-CVEs, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION, REQUEST-944-APPLICATION-ATTACK-JAVA and UnknownBots."

obj spec.forProvider.managedRules.managedRuleSet

"One or more managed_rule_set block defined below."

fn spec.forProvider.managedRules.managedRuleSet.withRuleGroupOverride

withRuleGroupOverride(ruleGroupOverride)

"One or more rule_group_override block defined below."

fn spec.forProvider.managedRules.managedRuleSet.withRuleGroupOverrideMixin

withRuleGroupOverrideMixin(ruleGroupOverride)

"One or more rule_group_override block defined below."

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.managedRuleSet.withType

withType(type)

"The rule set type. Possible values: Microsoft_BotManagerRuleSet and OWASP."

fn spec.forProvider.managedRules.managedRuleSet.withVersion

withVersion(version)

"The rule set version. Possible values: 0.1, 1.0, 2.2.9, 3.0, 3.1 and 3.2."

obj spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride

"One or more rule_group_override block defined below."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.withDisabledRules

withDisabledRules(disabledRules)

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.withDisabledRulesMixin

withDisabledRulesMixin(disabledRules)

Note: This function appends passed data to existing values

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.withRule

withRule(rule)

"One or more rule block defined below."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.withRuleGroupName

withRuleGroupName(ruleGroupName)

"The name of the Rule Group. Possible values are BadBots, crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, GoodBots, Known-CVEs, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION, REQUEST-944-APPLICATION-ATTACK-JAVA and UnknownBots."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.withRuleMixin

withRuleMixin(rule)

"One or more rule block defined below."

Note: This function appends passed data to existing values

obj spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.rule

"One or more rule block defined below."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.rule.withAction

withAction(action)

"Describes the override action to be applied when rule matches. Possible values are Allow, AnomalyScoring, Block and Log."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.rule.withEnabled

withEnabled(enabled)

"Describes if the managed rule is in enabled state or disabled state."

fn spec.forProvider.managedRules.managedRuleSet.ruleGroupOverride.rule.withId

withId(id)

"Identifier for the managed rule."

obj spec.forProvider.policySettings

"A policy_settings block as defined below."

fn spec.forProvider.policySettings.withEnabled

withEnabled(enabled)

"Describes if the policy is in enabled state or disabled state. Defaults to true."

fn spec.forProvider.policySettings.withFileUploadLimitInMb

withFileUploadLimitInMb(fileUploadLimitInMb)

"The File Upload Limit in MB. Accepted values are in the range 1 to 4000. Defaults to 100."

fn spec.forProvider.policySettings.withMaxRequestBodySizeInKb

withMaxRequestBodySizeInKb(maxRequestBodySizeInKb)

"The Maximum Request Body Size in KB. Accepted values are in the range 8 to 2000. Defaults to 128."

fn spec.forProvider.policySettings.withMode

withMode(mode)

"Describes if it is in detection mode or prevention mode at the policy level. Valid values are Detection and Prevention. Defaults to Prevention."

fn spec.forProvider.policySettings.withRequestBodyCheck

withRequestBodyCheck(requestBodyCheck)

"Is Request Body Inspection enabled? Defaults to true."

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