insights.v1beta1.monitorScheduledQueryRulesAlertV2
"MonitorScheduledQueryRulesAlertV2 is the Schema for the MonitorScheduledQueryRulesAlertV2s API. Manages an AlertingAction Scheduled Query Rules Version 2 resource within Azure Monitor"
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
obj spec.forProvider
fn withAction(action)
fn withActionMixin(action)
fn withAutoMitigationEnabled(autoMitigationEnabled)
fn withCriteria(criteria)
fn withCriteriaMixin(criteria)
fn withDescription(description)
fn withDisplayName(displayName)
fn withEnabled(enabled)
fn withEvaluationFrequency(evaluationFrequency)
fn withLocation(location)
fn withMuteActionsAfterAlertDuration(muteActionsAfterAlertDuration)
fn withQueryTimeRangeOverride(queryTimeRangeOverride)
fn withResourceGroupName(resourceGroupName)
fn withScopes(scopes)
fn withScopesMixin(scopes)
fn withScopesRefs(scopesRefs)
fn withScopesRefsMixin(scopesRefs)
fn withSeverity(severity)
fn withSkipQueryValidation(skipQueryValidation)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTargetResourceTypes(targetResourceTypes)
fn withTargetResourceTypesMixin(targetResourceTypes)
fn withWindowDuration(windowDuration)
fn withWorkspaceAlertsStorageEnabled(workspaceAlertsStorageEnabled)
obj spec.forProvider.action
obj spec.forProvider.criteria
fn withDimension(dimension)
fn withDimensionMixin(dimension)
fn withFailingPeriods(failingPeriods)
fn withFailingPeriodsMixin(failingPeriods)
fn withMetricMeasureColumn(metricMeasureColumn)
fn withOperator(operator)
fn withQuery(query)
fn withResourceIdColumn(resourceIdColumn)
fn withThreshold(threshold)
fn withTimeAggregationMethod(timeAggregationMethod)
obj spec.forProvider.criteria.dimension
obj spec.forProvider.criteria.failingPeriods
obj spec.forProvider.resourceGroupNameRef
obj spec.forProvider.resourceGroupNameSelector
obj spec.forProvider.scopesRefs
obj spec.forProvider.scopesSelector
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of MonitorScheduledQueryRulesAlertV2
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"MonitorScheduledQueryRulesAlertV2Spec defines the desired state of MonitorScheduledQueryRulesAlertV2"
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.withAction
withAction(action)
"An action block as defined below."
fn spec.forProvider.withActionMixin
withActionMixin(action)
"An action block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withAutoMitigationEnabled
withAutoMitigationEnabled(autoMitigationEnabled)
"Specifies the flag that indicates whether the alert should be automatically resolved or not. Value should be true or false. The default is false."
fn spec.forProvider.withCriteria
withCriteria(criteria)
"A criteria block as defined below."
fn spec.forProvider.withCriteriaMixin
withCriteriaMixin(criteria)
"A criteria block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.withDescription
withDescription(description)
"Specifies the description of the scheduled query rule."
fn spec.forProvider.withDisplayName
withDisplayName(displayName)
"Specifies the display name of the alert rule."
fn spec.forProvider.withEnabled
withEnabled(enabled)
"Specifies the flag which indicates whether this scheduled query rule is enabled. Value should be true or false. The default is true."
fn spec.forProvider.withEvaluationFrequency
withEvaluationFrequency(evaluationFrequency)
"How often the scheduled query rule is evaluated, represented in ISO 8601 duration format. Possible values are PT1M, PT5M, PT10M, PT15M, PT30M, PT45M, PT1H, PT2H, PT3H, PT4H, PT5H, PT6H, P1D."
fn spec.forProvider.withLocation
withLocation(location)
"Specifies the Azure Region where the Monitor Scheduled Query Rule should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withMuteActionsAfterAlertDuration
withMuteActionsAfterAlertDuration(muteActionsAfterAlertDuration)
"Mute actions for the chosen period of time in ISO 8601 duration format after the alert is fired. Possible values are PT5M, PT10M, PT15M, PT30M, PT45M, PT1H, PT2H, PT3H, PT4H, PT5H, PT6H, P1D and P2D."
fn spec.forProvider.withQueryTimeRangeOverride
withQueryTimeRangeOverride(queryTimeRangeOverride)
"Set this if the alert evaluation period is different from the query time range. If not specified, the value is window_duration*number_of_evaluation_periods. Possible values are PT5M, PT10M, PT15M, PT20M, PT30M, PT45M, PT1H, PT2H, PT3H, PT4H, PT5H, PT6H, P1D and P2D."
fn spec.forProvider.withResourceGroupName
withResourceGroupName(resourceGroupName)
"Specifies the name of the Resource Group where the Monitor Scheduled Query Rule should exist. Changing this forces a new resource to be created."
fn spec.forProvider.withScopes
withScopes(scopes)
"Specifies the list of resource IDs that this scheduled query rule is scoped to. Changing this forces a new resource to be created. Currently, the API supports exactly 1 resource ID in the scopes list."
fn spec.forProvider.withScopesMixin
withScopesMixin(scopes)
"Specifies the list of resource IDs that this scheduled query rule is scoped to. Changing this forces a new resource to be created. Currently, the API supports exactly 1 resource ID in the scopes list."
Note: This function appends passed data to existing values
fn spec.forProvider.withScopesRefs
withScopesRefs(scopesRefs)
"References to ApplicationInsights to populate scopes."
fn spec.forProvider.withScopesRefsMixin
withScopesRefsMixin(scopesRefs)
"References to ApplicationInsights to populate scopes."
Note: This function appends passed data to existing values
fn spec.forProvider.withSeverity
withSeverity(severity)
"Severity of the alert. Should be an integer between 0 and 4. Value of 0 is severest."
fn spec.forProvider.withSkipQueryValidation
withSkipQueryValidation(skipQueryValidation)
"Specifies the flag which indicates whether the provided query should be validated or not. The default is false."
fn spec.forProvider.withTags
withTags(tags)
"A mapping of tags which should be assigned to the Monitor Scheduled Query Rule."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A mapping of tags which should be assigned to the Monitor Scheduled Query Rule."
Note: This function appends passed data to existing values
fn spec.forProvider.withTargetResourceTypes
withTargetResourceTypes(targetResourceTypes)
"List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria."
fn spec.forProvider.withTargetResourceTypesMixin
withTargetResourceTypesMixin(targetResourceTypes)
"List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria."
Note: This function appends passed data to existing values
fn spec.forProvider.withWindowDuration
withWindowDuration(windowDuration)
"Specifies the period of time in ISO 8601 duration format on which the Scheduled Query Rule will be executed (bin size). If evaluation_frequency is PT1M, possible values are PT1M, PT5M, PT10M, PT15M, PT30M, PT45M, PT1H, PT2H, PT3H, PT4H, PT5H, and PT6H. Otherwise, possible values are PT5M, PT10M, PT15M, PT30M, PT45M, PT1H, PT2H, PT3H, PT4H, PT5H, PT6H, P1D, and P2D."
fn spec.forProvider.withWorkspaceAlertsStorageEnabled
withWorkspaceAlertsStorageEnabled(workspaceAlertsStorageEnabled)
"Specifies the flag which indicates whether this scheduled query rule check if storage is configured. Value should be true or false. The default is false."
obj spec.forProvider.action
"An action block as defined below."
fn spec.forProvider.action.withActionGroups
withActionGroups(actionGroups)
"List of Action Group resource IDs to invoke when the alert fires."
fn spec.forProvider.action.withActionGroupsMixin
withActionGroupsMixin(actionGroups)
"List of Action Group resource IDs to invoke when the alert fires."
Note: This function appends passed data to existing values
fn spec.forProvider.action.withCustomProperties
withCustomProperties(customProperties)
"Specifies the properties of an alert payload."
fn spec.forProvider.action.withCustomPropertiesMixin
withCustomPropertiesMixin(customProperties)
"Specifies the properties of an alert payload."
Note: This function appends passed data to existing values
obj spec.forProvider.criteria
"A criteria block as defined below."
fn spec.forProvider.criteria.withDimension
withDimension(dimension)
"A dimension block as defined below."
fn spec.forProvider.criteria.withDimensionMixin
withDimensionMixin(dimension)
"A dimension block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.criteria.withFailingPeriods
withFailingPeriods(failingPeriods)
"A failing_periods block as defined below."
fn spec.forProvider.criteria.withFailingPeriodsMixin
withFailingPeriodsMixin(failingPeriods)
"A failing_periods block as defined below."
Note: This function appends passed data to existing values
fn spec.forProvider.criteria.withMetricMeasureColumn
withMetricMeasureColumn(metricMeasureColumn)
"Specifies the column containing the metric measure number."
fn spec.forProvider.criteria.withOperator
withOperator(operator)
"Specifies the criteria operator. Possible values are Equal, GreaterThan, GreaterThanOrEqual, LessThan,and LessThanOrEqual."
fn spec.forProvider.criteria.withQuery
withQuery(query)
"The query to run on logs. The results returned by this query are used to populate the alert."
fn spec.forProvider.criteria.withResourceIdColumn
withResourceIdColumn(resourceIdColumn)
"Specifies the column containing the resource ID. The content of the column must be an uri formatted as resource ID."
fn spec.forProvider.criteria.withThreshold
withThreshold(threshold)
"Specifies the criteria threshold value that activates the alert."
fn spec.forProvider.criteria.withTimeAggregationMethod
withTimeAggregationMethod(timeAggregationMethod)
"The type of aggregation to apply to the data points in aggregation granularity. Possible values are Average, Count, Maximum, Minimum,and Total."
obj spec.forProvider.criteria.dimension
"A dimension block as defined below."
fn spec.forProvider.criteria.dimension.withName
withName(name)
"Specifies the name which should be used for this Monitor Scheduled Query Rule. Changing this forces a new resource to be created."
fn spec.forProvider.criteria.dimension.withOperator
withOperator(operator)
"Operator for dimension values. Possible values are Exclude,and Include."
fn spec.forProvider.criteria.dimension.withValues
withValues(values)
"List of dimension values. Use a wildcard * to collect all."
fn spec.forProvider.criteria.dimension.withValuesMixin
withValuesMixin(values)
"List of dimension values. Use a wildcard * to collect all."
Note: This function appends passed data to existing values
obj spec.forProvider.criteria.failingPeriods
"A failing_periods block as defined below."
fn spec.forProvider.criteria.failingPeriods.withMinimumFailingPeriodsToTriggerAlert
withMinimumFailingPeriodsToTriggerAlert(minimumFailingPeriodsToTriggerAlert)
"Specifies the number of violations to trigger an alert. Should be smaller or equal to number_of_evaluation_periods. Possible value is integer between 1 and 6."
fn spec.forProvider.criteria.failingPeriods.withNumberOfEvaluationPeriods
withNumberOfEvaluationPeriods(numberOfEvaluationPeriods)
"Specifies the number of aggregated look-back points. The look-back time window is calculated based on the aggregation granularity window_duration and the selected number of aggregated points. Possible value is integer between 1 and 6."
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.scopesRefs
"References to ApplicationInsights to populate scopes."
fn spec.forProvider.scopesRefs.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.scopesRefs.policy
"Policies for referencing."
fn spec.forProvider.scopesRefs.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.scopesRefs.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.scopesSelector
"Selector for a list of ApplicationInsights to populate scopes."
fn spec.forProvider.scopesSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.scopesSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.scopesSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.scopesSelector.policy
"Policies for selection."
fn spec.forProvider.scopesSelector.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.scopesSelector.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."