Skip to content

osconfig.v1beta1.patchDeployment

"PatchDeployment is the Schema for the PatchDeployments API. Patch deployments are configurations that individual patch jobs use to complete a patch."

Index

Fields

fn new

new(name)

new returns an instance of PatchDeployment

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

"PatchDeploymentSpec defines the desired state of PatchDeployment"

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. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withDescription

withDescription(description)

"Description of the patch deployment. Length of the description is limited to 1024 characters."

fn spec.forProvider.withDuration

withDuration(duration)

"Duration of the patch. After the duration ends, the patch times out. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\

fn spec.forProvider.withInstanceFilter

withInstanceFilter(instanceFilter)

"VM instances to patch. Structure is documented below."

fn spec.forProvider.withInstanceFilterMixin

withInstanceFilterMixin(instanceFilter)

"VM instances to patch. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOneTimeSchedule

withOneTimeSchedule(oneTimeSchedule)

"Schedule a one-time execution. Structure is documented below."

fn spec.forProvider.withOneTimeScheduleMixin

withOneTimeScheduleMixin(oneTimeSchedule)

"Schedule a one-time execution. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withPatchConfig

withPatchConfig(patchConfig)

"Patch configuration that is applied. Structure is documented below."

fn spec.forProvider.withPatchConfigMixin

withPatchConfigMixin(patchConfig)

"Patch configuration that is applied. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withProject

withProject(project)

"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."

fn spec.forProvider.withRecurringSchedule

withRecurringSchedule(recurringSchedule)

"Schedule recurring executions. Structure is documented below."

fn spec.forProvider.withRecurringScheduleMixin

withRecurringScheduleMixin(recurringSchedule)

"Schedule recurring executions. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withRollout

withRollout(rollout)

"Rollout strategy of the patch job. Structure is documented below."

fn spec.forProvider.withRolloutMixin

withRolloutMixin(rollout)

"Rollout strategy of the patch job. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.instanceFilter

"VM instances to patch. Structure is documented below."

fn spec.forProvider.instanceFilter.withAll

withAll(all)

"Target all VM instances in the project. If true, no other criteria is permitted."

fn spec.forProvider.instanceFilter.withGroupLabels

withGroupLabels(groupLabels)

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

fn spec.forProvider.instanceFilter.withGroupLabelsMixin

withGroupLabelsMixin(groupLabels)

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.instanceFilter.withInstanceNamePrefixes

withInstanceNamePrefixes(instanceNamePrefixes)

"Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\"."

fn spec.forProvider.instanceFilter.withInstanceNamePrefixesMixin

withInstanceNamePrefixesMixin(instanceNamePrefixes)

"Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\"."

Note: This function appends passed data to existing values

fn spec.forProvider.instanceFilter.withInstances

withInstances(instances)

"Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}"

fn spec.forProvider.instanceFilter.withInstancesMixin

withInstancesMixin(instances)

"Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}"

Note: This function appends passed data to existing values

fn spec.forProvider.instanceFilter.withZones

withZones(zones)

"Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone."

fn spec.forProvider.instanceFilter.withZonesMixin

withZonesMixin(zones)

"Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone."

Note: This function appends passed data to existing values

obj spec.forProvider.instanceFilter.groupLabels

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

fn spec.forProvider.instanceFilter.groupLabels.withLabels

withLabels(labels)

"Compute Engine instance labels that must be present for a VM instance to be targeted by this filter"

fn spec.forProvider.instanceFilter.groupLabels.withLabelsMixin

withLabelsMixin(labels)

"Compute Engine instance labels that must be present for a VM instance to be targeted by this filter"

Note: This function appends passed data to existing values

obj spec.forProvider.oneTimeSchedule

"Schedule a one-time execution. Structure is documented below."

fn spec.forProvider.oneTimeSchedule.withExecuteTime

withExecuteTime(executeTime)

"The desired patch job execution time. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

obj spec.forProvider.patchConfig

"Patch configuration that is applied. Structure is documented below."

fn spec.forProvider.patchConfig.withApt

withApt(apt)

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.withAptMixin

withAptMixin(apt)

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withGoo

withGoo(goo)

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.withGooMixin

withGooMixin(goo)

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withMigInstancesAllowed

withMigInstancesAllowed(migInstancesAllowed)

"Allows the patch job to run on Managed instance groups (MIGs)."

fn spec.forProvider.patchConfig.withPostStep

withPostStep(postStep)

"The ExecStep to run after the patch update. Structure is documented below."

fn spec.forProvider.patchConfig.withPostStepMixin

withPostStepMixin(postStep)

"The ExecStep to run after the patch update. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withPreStep

withPreStep(preStep)

"The ExecStep to run before the patch update. Structure is documented below."

fn spec.forProvider.patchConfig.withPreStepMixin

withPreStepMixin(preStep)

"The ExecStep to run before the patch update. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withRebootConfig

withRebootConfig(rebootConfig)

"Post-patch reboot settings. Possible values are: DEFAULT, ALWAYS, NEVER."

fn spec.forProvider.patchConfig.withWindowsUpdate

withWindowsUpdate(windowsUpdate)

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.withWindowsUpdateMixin

withWindowsUpdateMixin(windowsUpdate)

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withYum

withYum(yum)

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.withYumMixin

withYumMixin(yum)

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.withZypper

withZypper(zypper)

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.withZypperMixin

withZypperMixin(zypper)

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.patchConfig.apt

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.apt.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.forProvider.patchConfig.apt.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.apt.withExclusivePackages

withExclusivePackages(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

fn spec.forProvider.patchConfig.apt.withExclusivePackagesMixin

withExclusivePackagesMixin(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.apt.withType

withType(type)

"By changing the type to DIST, the patching is performed using apt-get dist-upgrade instead. Possible values are: DIST, UPGRADE."

obj spec.forProvider.patchConfig.goo

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.goo.withEnabled

withEnabled(enabled)

"goo update settings. Use this setting to override the default goo patch rules."

obj spec.forProvider.patchConfig.postStep

"The ExecStep to run after the patch update. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.withLinuxExecStepConfig

withLinuxExecStepConfig(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.withLinuxExecStepConfigMixin

withLinuxExecStepConfigMixin(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.postStep.withWindowsExecStepConfig

withWindowsExecStepConfig(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.withWindowsExecStepConfigMixin

withWindowsExecStepConfigMixin(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.patchConfig.postStep.linuxExecStepConfig

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.forProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.forProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.forProvider.patchConfig.postStep.windowsExecStepConfig

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.forProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.forProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.forProvider.patchConfig.preStep

"The ExecStep to run before the patch update. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.withLinuxExecStepConfig

withLinuxExecStepConfig(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.withLinuxExecStepConfigMixin

withLinuxExecStepConfigMixin(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.preStep.withWindowsExecStepConfig

withWindowsExecStepConfig(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.withWindowsExecStepConfigMixin

withWindowsExecStepConfigMixin(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.patchConfig.preStep.linuxExecStepConfig

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.forProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.forProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.forProvider.patchConfig.preStep.windowsExecStepConfig

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.forProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.forProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.forProvider.patchConfig.windowsUpdate

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.windowsUpdate.withClassifications

withClassifications(classifications)

"Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE."

fn spec.forProvider.patchConfig.windowsUpdate.withClassificationsMixin

withClassificationsMixin(classifications)

"Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.windowsUpdate.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.forProvider.patchConfig.windowsUpdate.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.windowsUpdate.withExclusivePatches

withExclusivePatches(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

fn spec.forProvider.patchConfig.windowsUpdate.withExclusivePatchesMixin

withExclusivePatchesMixin(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

Note: This function appends passed data to existing values

obj spec.forProvider.patchConfig.yum

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.yum.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.forProvider.patchConfig.yum.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.yum.withExclusivePackages

withExclusivePackages(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

fn spec.forProvider.patchConfig.yum.withExclusivePackagesMixin

withExclusivePackagesMixin(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.yum.withMinimal

withMinimal(minimal)

"Will cause patch to run yum update-minimal instead."

fn spec.forProvider.patchConfig.yum.withSecurity

withSecurity(security)

"Adds the --security flag to yum update. Not supported on all platforms."

obj spec.forProvider.patchConfig.zypper

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

fn spec.forProvider.patchConfig.zypper.withCategories

withCategories(categories)

"Install only patches with these categories. Common categories include security, recommended, and feature."

fn spec.forProvider.patchConfig.zypper.withCategoriesMixin

withCategoriesMixin(categories)

"Install only patches with these categories. Common categories include security, recommended, and feature."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.zypper.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.forProvider.patchConfig.zypper.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.zypper.withExclusivePatches

withExclusivePatches(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

fn spec.forProvider.patchConfig.zypper.withExclusivePatchesMixin

withExclusivePatchesMixin(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.zypper.withSeverities

withSeverities(severities)

"Install only patches with these severities. Common severities include critical, important, moderate, and low."

fn spec.forProvider.patchConfig.zypper.withSeveritiesMixin

withSeveritiesMixin(severities)

"Install only patches with these severities. Common severities include critical, important, moderate, and low."

Note: This function appends passed data to existing values

fn spec.forProvider.patchConfig.zypper.withWithOptional

withWithOptional(withOptional)

"Adds the --with-optional flag to zypper patch."

fn spec.forProvider.patchConfig.zypper.withWithUpdate

withWithUpdate(withUpdate)

"Adds the --with-update flag, to zypper patch."

obj spec.forProvider.recurringSchedule

"Schedule recurring executions. Structure is documented below."

fn spec.forProvider.recurringSchedule.withEndTime

withEndTime(endTime)

"The end time at which a recurring patch deployment schedule is no longer active. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

fn spec.forProvider.recurringSchedule.withMonthly

withMonthly(monthly)

"Schedule with monthly executions. Structure is documented below."

fn spec.forProvider.recurringSchedule.withMonthlyMixin

withMonthlyMixin(monthly)

"Schedule with monthly executions. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.recurringSchedule.withStartTime

withStartTime(startTime)

"The time that the recurring schedule becomes effective. Defaults to createTime of the patch deployment. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

fn spec.forProvider.recurringSchedule.withTimeOfDay

withTimeOfDay(timeOfDay)

"Time of the day to run a recurring deployment. Structure is documented below."

fn spec.forProvider.recurringSchedule.withTimeOfDayMixin

withTimeOfDayMixin(timeOfDay)

"Time of the day to run a recurring deployment. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.recurringSchedule.withTimeZone

withTimeZone(timeZone)

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

fn spec.forProvider.recurringSchedule.withTimeZoneMixin

withTimeZoneMixin(timeZone)

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.recurringSchedule.withWeekly

withWeekly(weekly)

"Schedule with weekly executions. Structure is documented below."

fn spec.forProvider.recurringSchedule.withWeeklyMixin

withWeeklyMixin(weekly)

"Schedule with weekly executions. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.recurringSchedule.monthly

"Schedule with monthly executions. Structure is documented below."

fn spec.forProvider.recurringSchedule.monthly.withMonthDay

withMonthDay(monthDay)

"One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run \"every month on the 31st\" will not run in February, April, June, etc."

fn spec.forProvider.recurringSchedule.monthly.withWeekDayOfMonth

withWeekDayOfMonth(weekDayOfMonth)

"Week day in a month. Structure is documented below."

fn spec.forProvider.recurringSchedule.monthly.withWeekDayOfMonthMixin

withWeekDayOfMonthMixin(weekDayOfMonth)

"Week day in a month. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.recurringSchedule.monthly.weekDayOfMonth

"Week day in a month. Structure is documented below."

fn spec.forProvider.recurringSchedule.monthly.weekDayOfMonth.withDayOfWeek

withDayOfWeek(dayOfWeek)

"IANA Time Zone Database time zone, e.g. \"America/New_York\". Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."

fn spec.forProvider.recurringSchedule.monthly.weekDayOfMonth.withWeekOrdinal

withWeekOrdinal(weekOrdinal)

"Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month."

obj spec.forProvider.recurringSchedule.timeOfDay

"Time of the day to run a recurring deployment. Structure is documented below."

fn spec.forProvider.recurringSchedule.timeOfDay.withHours

withHours(hours)

"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time."

fn spec.forProvider.recurringSchedule.timeOfDay.withMinutes

withMinutes(minutes)

"Minutes of hour of day. Must be from 0 to 59."

fn spec.forProvider.recurringSchedule.timeOfDay.withNanos

withNanos(nanos)

"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."

fn spec.forProvider.recurringSchedule.timeOfDay.withSeconds

withSeconds(seconds)

"Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds."

obj spec.forProvider.recurringSchedule.timeZone

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

fn spec.forProvider.recurringSchedule.timeZone.withId

withId(id)

"IANA Time Zone Database time zone, e.g. \"America/New_York\"."

fn spec.forProvider.recurringSchedule.timeZone.withVersion

withVersion(version)

"IANA Time Zone Database version number, e.g. \"2019a\"."

obj spec.forProvider.recurringSchedule.weekly

"Schedule with weekly executions. Structure is documented below."

fn spec.forProvider.recurringSchedule.weekly.withDayOfWeek

withDayOfWeek(dayOfWeek)

"IANA Time Zone Database time zone, e.g. \"America/New_York\". Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."

obj spec.forProvider.rollout

"Rollout strategy of the patch job. Structure is documented below."

fn spec.forProvider.rollout.withDisruptionBudget

withDisruptionBudget(disruptionBudget)

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

fn spec.forProvider.rollout.withDisruptionBudgetMixin

withDisruptionBudgetMixin(disruptionBudget)

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.rollout.withMode

withMode(mode)

"Mode of the patch rollout. Possible values are: ZONE_BY_ZONE, CONCURRENT_ZONES."

obj spec.forProvider.rollout.disruptionBudget

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

fn spec.forProvider.rollout.disruptionBudget.withFixed

withFixed(fixed)

"Specifies a fixed value."

fn spec.forProvider.rollout.disruptionBudget.withPercentage

withPercentage(percentage)

"Specifies the relative value defined as a percentage, which will be multiplied by a reference value."

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withDescription

withDescription(description)

"Description of the patch deployment. Length of the description is limited to 1024 characters."

fn spec.initProvider.withDuration

withDuration(duration)

"Duration of the patch. After the duration ends, the patch times out. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\

fn spec.initProvider.withInstanceFilter

withInstanceFilter(instanceFilter)

"VM instances to patch. Structure is documented below."

fn spec.initProvider.withInstanceFilterMixin

withInstanceFilterMixin(instanceFilter)

"VM instances to patch. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withOneTimeSchedule

withOneTimeSchedule(oneTimeSchedule)

"Schedule a one-time execution. Structure is documented below."

fn spec.initProvider.withOneTimeScheduleMixin

withOneTimeScheduleMixin(oneTimeSchedule)

"Schedule a one-time execution. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withPatchConfig

withPatchConfig(patchConfig)

"Patch configuration that is applied. Structure is documented below."

fn spec.initProvider.withPatchConfigMixin

withPatchConfigMixin(patchConfig)

"Patch configuration that is applied. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withProject

withProject(project)

"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."

fn spec.initProvider.withRecurringSchedule

withRecurringSchedule(recurringSchedule)

"Schedule recurring executions. Structure is documented below."

fn spec.initProvider.withRecurringScheduleMixin

withRecurringScheduleMixin(recurringSchedule)

"Schedule recurring executions. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withRollout

withRollout(rollout)

"Rollout strategy of the patch job. Structure is documented below."

fn spec.initProvider.withRolloutMixin

withRolloutMixin(rollout)

"Rollout strategy of the patch job. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.instanceFilter

"VM instances to patch. Structure is documented below."

fn spec.initProvider.instanceFilter.withAll

withAll(all)

"Target all VM instances in the project. If true, no other criteria is permitted."

fn spec.initProvider.instanceFilter.withGroupLabels

withGroupLabels(groupLabels)

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

fn spec.initProvider.instanceFilter.withGroupLabelsMixin

withGroupLabelsMixin(groupLabels)

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.instanceFilter.withInstanceNamePrefixes

withInstanceNamePrefixes(instanceNamePrefixes)

"Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\"."

fn spec.initProvider.instanceFilter.withInstanceNamePrefixesMixin

withInstanceNamePrefixesMixin(instanceNamePrefixes)

"Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\"."

Note: This function appends passed data to existing values

fn spec.initProvider.instanceFilter.withInstances

withInstances(instances)

"Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}"

fn spec.initProvider.instanceFilter.withInstancesMixin

withInstancesMixin(instances)

"Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}"

Note: This function appends passed data to existing values

fn spec.initProvider.instanceFilter.withZones

withZones(zones)

"Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone."

fn spec.initProvider.instanceFilter.withZonesMixin

withZonesMixin(zones)

"Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone."

Note: This function appends passed data to existing values

obj spec.initProvider.instanceFilter.groupLabels

"Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below."

fn spec.initProvider.instanceFilter.groupLabels.withLabels

withLabels(labels)

"Compute Engine instance labels that must be present for a VM instance to be targeted by this filter"

fn spec.initProvider.instanceFilter.groupLabels.withLabelsMixin

withLabelsMixin(labels)

"Compute Engine instance labels that must be present for a VM instance to be targeted by this filter"

Note: This function appends passed data to existing values

obj spec.initProvider.oneTimeSchedule

"Schedule a one-time execution. Structure is documented below."

fn spec.initProvider.oneTimeSchedule.withExecuteTime

withExecuteTime(executeTime)

"The desired patch job execution time. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

obj spec.initProvider.patchConfig

"Patch configuration that is applied. Structure is documented below."

fn spec.initProvider.patchConfig.withApt

withApt(apt)

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.withAptMixin

withAptMixin(apt)

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withGoo

withGoo(goo)

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.withGooMixin

withGooMixin(goo)

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withMigInstancesAllowed

withMigInstancesAllowed(migInstancesAllowed)

"Allows the patch job to run on Managed instance groups (MIGs)."

fn spec.initProvider.patchConfig.withPostStep

withPostStep(postStep)

"The ExecStep to run after the patch update. Structure is documented below."

fn spec.initProvider.patchConfig.withPostStepMixin

withPostStepMixin(postStep)

"The ExecStep to run after the patch update. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withPreStep

withPreStep(preStep)

"The ExecStep to run before the patch update. Structure is documented below."

fn spec.initProvider.patchConfig.withPreStepMixin

withPreStepMixin(preStep)

"The ExecStep to run before the patch update. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withRebootConfig

withRebootConfig(rebootConfig)

"Post-patch reboot settings. Possible values are: DEFAULT, ALWAYS, NEVER."

fn spec.initProvider.patchConfig.withWindowsUpdate

withWindowsUpdate(windowsUpdate)

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.withWindowsUpdateMixin

withWindowsUpdateMixin(windowsUpdate)

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withYum

withYum(yum)

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.withYumMixin

withYumMixin(yum)

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.withZypper

withZypper(zypper)

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.withZypperMixin

withZypperMixin(zypper)

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.patchConfig.apt

"Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.apt.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.initProvider.patchConfig.apt.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.apt.withExclusivePackages

withExclusivePackages(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

fn spec.initProvider.patchConfig.apt.withExclusivePackagesMixin

withExclusivePackagesMixin(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.apt.withType

withType(type)

"By changing the type to DIST, the patching is performed using apt-get dist-upgrade instead. Possible values are: DIST, UPGRADE."

obj spec.initProvider.patchConfig.goo

"goo update settings. Use this setting to override the default goo patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.goo.withEnabled

withEnabled(enabled)

"goo update settings. Use this setting to override the default goo patch rules."

obj spec.initProvider.patchConfig.postStep

"The ExecStep to run after the patch update. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.withLinuxExecStepConfig

withLinuxExecStepConfig(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.withLinuxExecStepConfigMixin

withLinuxExecStepConfigMixin(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.postStep.withWindowsExecStepConfig

withWindowsExecStepConfig(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.withWindowsExecStepConfigMixin

withWindowsExecStepConfigMixin(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.patchConfig.postStep.linuxExecStepConfig

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.initProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.initProvider.patchConfig.postStep.linuxExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.initProvider.patchConfig.postStep.windowsExecStepConfig

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.initProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.initProvider.patchConfig.postStep.windowsExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.initProvider.patchConfig.preStep

"The ExecStep to run before the patch update. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.withLinuxExecStepConfig

withLinuxExecStepConfig(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.withLinuxExecStepConfigMixin

withLinuxExecStepConfigMixin(linuxExecStepConfig)

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.preStep.withWindowsExecStepConfig

withWindowsExecStepConfig(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.withWindowsExecStepConfigMixin

withWindowsExecStepConfigMixin(windowsExecStepConfig)

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.patchConfig.preStep.linuxExecStepConfig

"The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.initProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.initProvider.patchConfig.preStep.linuxExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.initProvider.patchConfig.preStep.windowsExecStepConfig

"The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withAllowedSuccessCodes

withAllowedSuccessCodes(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withAllowedSuccessCodesMixin

withAllowedSuccessCodesMixin(allowedSuccessCodes)

"Defaults to [0]. A list of possible return values that the execution can return to indicate a success."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withGcsObject

withGcsObject(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withGcsObjectMixin

withGcsObjectMixin(gcsObject)

"A Cloud Storage object containing the executable. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withInterpreter

withInterpreter(interpreter)

"The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines. Possible values are: SHELL, POWERSHELL."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.withLocalPath

withLocalPath(localPath)

"An absolute path to the executable on the VM."

obj spec.initProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject

"A Cloud Storage object containing the executable. Structure is documented below."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withBucket

withBucket(bucket)

"Bucket of the Cloud Storage object."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withGenerationNumber

withGenerationNumber(generationNumber)

"Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change."

fn spec.initProvider.patchConfig.preStep.windowsExecStepConfig.gcsObject.withObject

withObject(object)

"Name of the Cloud Storage object."

obj spec.initProvider.patchConfig.windowsUpdate

"Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.windowsUpdate.withClassifications

withClassifications(classifications)

"Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE."

fn spec.initProvider.patchConfig.windowsUpdate.withClassificationsMixin

withClassificationsMixin(classifications)

"Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.windowsUpdate.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.initProvider.patchConfig.windowsUpdate.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.windowsUpdate.withExclusivePatches

withExclusivePatches(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

fn spec.initProvider.patchConfig.windowsUpdate.withExclusivePatchesMixin

withExclusivePatchesMixin(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

Note: This function appends passed data to existing values

obj spec.initProvider.patchConfig.yum

"Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.yum.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.initProvider.patchConfig.yum.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.yum.withExclusivePackages

withExclusivePackages(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

fn spec.initProvider.patchConfig.yum.withExclusivePackagesMixin

withExclusivePackagesMixin(exclusivePackages)

"An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.yum.withMinimal

withMinimal(minimal)

"Will cause patch to run yum update-minimal instead."

fn spec.initProvider.patchConfig.yum.withSecurity

withSecurity(security)

"Adds the --security flag to yum update. Not supported on all platforms."

obj spec.initProvider.patchConfig.zypper

"zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below."

fn spec.initProvider.patchConfig.zypper.withCategories

withCategories(categories)

"Install only patches with these categories. Common categories include security, recommended, and feature."

fn spec.initProvider.patchConfig.zypper.withCategoriesMixin

withCategoriesMixin(categories)

"Install only patches with these categories. Common categories include security, recommended, and feature."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.zypper.withExcludes

withExcludes(excludes)

"List of packages to exclude from update."

fn spec.initProvider.patchConfig.zypper.withExcludesMixin

withExcludesMixin(excludes)

"List of packages to exclude from update."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.zypper.withExclusivePatches

withExclusivePatches(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

fn spec.initProvider.patchConfig.zypper.withExclusivePatchesMixin

withExclusivePatchesMixin(exclusivePatches)

"An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.zypper.withSeverities

withSeverities(severities)

"Install only patches with these severities. Common severities include critical, important, moderate, and low."

fn spec.initProvider.patchConfig.zypper.withSeveritiesMixin

withSeveritiesMixin(severities)

"Install only patches with these severities. Common severities include critical, important, moderate, and low."

Note: This function appends passed data to existing values

fn spec.initProvider.patchConfig.zypper.withWithOptional

withWithOptional(withOptional)

"Adds the --with-optional flag to zypper patch."

fn spec.initProvider.patchConfig.zypper.withWithUpdate

withWithUpdate(withUpdate)

"Adds the --with-update flag, to zypper patch."

obj spec.initProvider.recurringSchedule

"Schedule recurring executions. Structure is documented below."

fn spec.initProvider.recurringSchedule.withEndTime

withEndTime(endTime)

"The end time at which a recurring patch deployment schedule is no longer active. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

fn spec.initProvider.recurringSchedule.withMonthly

withMonthly(monthly)

"Schedule with monthly executions. Structure is documented below."

fn spec.initProvider.recurringSchedule.withMonthlyMixin

withMonthlyMixin(monthly)

"Schedule with monthly executions. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.recurringSchedule.withStartTime

withStartTime(startTime)

"The time that the recurring schedule becomes effective. Defaults to createTime of the patch deployment. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"."

fn spec.initProvider.recurringSchedule.withTimeOfDay

withTimeOfDay(timeOfDay)

"Time of the day to run a recurring deployment. Structure is documented below."

fn spec.initProvider.recurringSchedule.withTimeOfDayMixin

withTimeOfDayMixin(timeOfDay)

"Time of the day to run a recurring deployment. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.recurringSchedule.withTimeZone

withTimeZone(timeZone)

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

fn spec.initProvider.recurringSchedule.withTimeZoneMixin

withTimeZoneMixin(timeZone)

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.recurringSchedule.withWeekly

withWeekly(weekly)

"Schedule with weekly executions. Structure is documented below."

fn spec.initProvider.recurringSchedule.withWeeklyMixin

withWeeklyMixin(weekly)

"Schedule with weekly executions. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.recurringSchedule.monthly

"Schedule with monthly executions. Structure is documented below."

fn spec.initProvider.recurringSchedule.monthly.withMonthDay

withMonthDay(monthDay)

"One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run \"every month on the 31st\" will not run in February, April, June, etc."

fn spec.initProvider.recurringSchedule.monthly.withWeekDayOfMonth

withWeekDayOfMonth(weekDayOfMonth)

"Week day in a month. Structure is documented below."

fn spec.initProvider.recurringSchedule.monthly.withWeekDayOfMonthMixin

withWeekDayOfMonthMixin(weekDayOfMonth)

"Week day in a month. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.recurringSchedule.monthly.weekDayOfMonth

"Week day in a month. Structure is documented below."

fn spec.initProvider.recurringSchedule.monthly.weekDayOfMonth.withDayOfWeek

withDayOfWeek(dayOfWeek)

"IANA Time Zone Database time zone, e.g. \"America/New_York\". Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."

fn spec.initProvider.recurringSchedule.monthly.weekDayOfMonth.withWeekOrdinal

withWeekOrdinal(weekOrdinal)

"Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month."

obj spec.initProvider.recurringSchedule.timeOfDay

"Time of the day to run a recurring deployment. Structure is documented below."

fn spec.initProvider.recurringSchedule.timeOfDay.withHours

withHours(hours)

"Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time."

fn spec.initProvider.recurringSchedule.timeOfDay.withMinutes

withMinutes(minutes)

"Minutes of hour of day. Must be from 0 to 59."

fn spec.initProvider.recurringSchedule.timeOfDay.withNanos

withNanos(nanos)

"Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."

fn spec.initProvider.recurringSchedule.timeOfDay.withSeconds

withSeconds(seconds)

"Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds."

obj spec.initProvider.recurringSchedule.timeZone

"Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below."

fn spec.initProvider.recurringSchedule.timeZone.withId

withId(id)

"IANA Time Zone Database time zone, e.g. \"America/New_York\"."

fn spec.initProvider.recurringSchedule.timeZone.withVersion

withVersion(version)

"IANA Time Zone Database version number, e.g. \"2019a\"."

obj spec.initProvider.recurringSchedule.weekly

"Schedule with weekly executions. Structure is documented below."

fn spec.initProvider.recurringSchedule.weekly.withDayOfWeek

withDayOfWeek(dayOfWeek)

"IANA Time Zone Database time zone, e.g. \"America/New_York\". Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."

obj spec.initProvider.rollout

"Rollout strategy of the patch job. Structure is documented below."

fn spec.initProvider.rollout.withDisruptionBudget

withDisruptionBudget(disruptionBudget)

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

fn spec.initProvider.rollout.withDisruptionBudgetMixin

withDisruptionBudgetMixin(disruptionBudget)

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.rollout.withMode

withMode(mode)

"Mode of the patch rollout. Possible values are: ZONE_BY_ZONE, CONCURRENT_ZONES."

obj spec.initProvider.rollout.disruptionBudget

"The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below."

fn spec.initProvider.rollout.disruptionBudget.withFixed

withFixed(fixed)

"Specifies a fixed value."

fn spec.initProvider.rollout.disruptionBudget.withPercentage

withPercentage(percentage)

"Specifies the relative value defined as a percentage, which will be multiplied by a reference value."

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