Skip to content

compute.v1beta1.regionAutoscaler

"RegionAutoscaler is the Schema for the RegionAutoscalers API. Represents an Autoscaler resource."

Index

Fields

fn new

new(name)

new returns an instance of RegionAutoscaler

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

"RegionAutoscalerSpec defines the desired state of RegionAutoscaler"

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

withAutoscalingPolicy(autoscalingPolicy)

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

fn spec.forProvider.withAutoscalingPolicyMixin

withAutoscalingPolicyMixin(autoscalingPolicy)

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDescription

withDescription(description)

"A description of a scaling schedule."

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

withRegion(region)

"URL of the region where the instance group resides."

fn spec.forProvider.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

obj spec.forProvider.autoscalingPolicy

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withCooldownPeriod

withCooldownPeriod(cooldownPeriod)

"The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process."

fn spec.forProvider.autoscalingPolicy.withCpuUtilization

withCpuUtilization(cpuUtilization)

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withCpuUtilizationMixin

withCpuUtilizationMixin(cpuUtilization)

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.autoscalingPolicy.withLoadBalancingUtilization

withLoadBalancingUtilization(loadBalancingUtilization)

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withLoadBalancingUtilizationMixin

withLoadBalancingUtilizationMixin(loadBalancingUtilization)

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.autoscalingPolicy.withMaxReplicas

withMaxReplicas(maxReplicas)

"The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."

fn spec.forProvider.autoscalingPolicy.withMetric

withMetric(metric)

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withMetricMixin

withMetricMixin(metric)

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.autoscalingPolicy.withMinReplicas

withMinReplicas(minReplicas)

"The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed."

fn spec.forProvider.autoscalingPolicy.withMode

withMode(mode)

"Defines operating mode for this policy. Default value is ON. Possible values are: OFF, ONLY_UP, ON."

fn spec.forProvider.autoscalingPolicy.withScaleInControl

withScaleInControl(scaleInControl)

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withScaleInControlMixin

withScaleInControlMixin(scaleInControl)

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.autoscalingPolicy.withScalingSchedules

withScalingSchedules(scalingSchedules)

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.withScalingSchedulesMixin

withScalingSchedulesMixin(scalingSchedules)

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.autoscalingPolicy.cpuUtilization

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.cpuUtilization.withPredictiveMethod

withPredictiveMethod(predictiveMethod)

"Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are:"

fn spec.forProvider.autoscalingPolicy.cpuUtilization.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

obj spec.forProvider.autoscalingPolicy.loadBalancingUtilization

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.loadBalancingUtilization.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

obj spec.forProvider.autoscalingPolicy.metric

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.metric.withName

withName(name)

"The identifier for this object. Format specified above."

fn spec.forProvider.autoscalingPolicy.metric.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

fn spec.forProvider.autoscalingPolicy.metric.withType

withType(type)

"Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Possible values are: GAUGE, DELTA_PER_SECOND, DELTA_PER_MINUTE."

obj spec.forProvider.autoscalingPolicy.scaleInControl

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

fn spec.forProvider.autoscalingPolicy.scaleInControl.withMaxScaledInReplicas

withMaxScaledInReplicas(maxScaledInReplicas)

"A nested object resource Structure is documented below."

fn spec.forProvider.autoscalingPolicy.scaleInControl.withMaxScaledInReplicasMixin

withMaxScaledInReplicasMixin(maxScaledInReplicas)

"A nested object resource Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.autoscalingPolicy.scaleInControl.withTimeWindowSec

withTimeWindowSec(timeWindowSec)

"How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above."

obj spec.forProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas

"A nested object resource Structure is documented below."

fn spec.forProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas.withFixed

withFixed(fixed)

"Specifies a fixed number of VM instances. This must be a positive integer."

fn spec.forProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas.withPercent

withPercent(percent)

"Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."

obj spec.forProvider.autoscalingPolicy.scalingSchedules

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withDescription

withDescription(description)

"A description of a scaling schedule."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withDisabled

withDisabled(disabled)

"A boolean value that specifies if a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withDurationSec

withDurationSec(durationSec)

"The duration of time intervals (in seconds) for which this scaling schedule will be running. The minimum allowed value is 300."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withMinRequiredReplicas

withMinRequiredReplicas(minRequiredReplicas)

"Minimum number of VM instances that autoscaler will recommend in time intervals starting according to schedule."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withName

withName(name)

"The identifier for this object. Format specified above."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withSchedule

withSchedule(schedule)

"The start timestamps of time intervals when this scaling schedule should provide a scaling signal. This field uses the extended cron format (with an optional year field)."

fn spec.forProvider.autoscalingPolicy.scalingSchedules.withTimeZone

withTimeZone(timeZone)

"The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database."

obj spec.forProvider.targetRef

"Reference to a RegionInstanceGroupManager in compute to populate target."

fn spec.forProvider.targetRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targetRef.policy

"Policies for referencing."

fn spec.forProvider.targetRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.targetRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.targetSelector

"Selector for a RegionInstanceGroupManager in compute to populate target."

fn spec.forProvider.targetSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.targetSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.targetSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.targetSelector.policy

"Policies for selection."

fn spec.forProvider.targetSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.targetSelector.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.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.withAutoscalingPolicy

withAutoscalingPolicy(autoscalingPolicy)

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

fn spec.initProvider.withAutoscalingPolicyMixin

withAutoscalingPolicyMixin(autoscalingPolicy)

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withDescription

withDescription(description)

"A description of a scaling schedule."

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

obj spec.initProvider.autoscalingPolicy

"The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withCooldownPeriod

withCooldownPeriod(cooldownPeriod)

"The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process."

fn spec.initProvider.autoscalingPolicy.withCpuUtilization

withCpuUtilization(cpuUtilization)

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withCpuUtilizationMixin

withCpuUtilizationMixin(cpuUtilization)

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.autoscalingPolicy.withLoadBalancingUtilization

withLoadBalancingUtilization(loadBalancingUtilization)

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withLoadBalancingUtilizationMixin

withLoadBalancingUtilizationMixin(loadBalancingUtilization)

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.autoscalingPolicy.withMaxReplicas

withMaxReplicas(maxReplicas)

"The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas."

fn spec.initProvider.autoscalingPolicy.withMetric

withMetric(metric)

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withMetricMixin

withMetricMixin(metric)

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.autoscalingPolicy.withMinReplicas

withMinReplicas(minReplicas)

"The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed."

fn spec.initProvider.autoscalingPolicy.withMode

withMode(mode)

"Defines operating mode for this policy. Default value is ON. Possible values are: OFF, ONLY_UP, ON."

fn spec.initProvider.autoscalingPolicy.withScaleInControl

withScaleInControl(scaleInControl)

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withScaleInControlMixin

withScaleInControlMixin(scaleInControl)

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.autoscalingPolicy.withScalingSchedules

withScalingSchedules(scalingSchedules)

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.withScalingSchedulesMixin

withScalingSchedulesMixin(scalingSchedules)

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.autoscalingPolicy.cpuUtilization

"Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.cpuUtilization.withPredictiveMethod

withPredictiveMethod(predictiveMethod)

"Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are:"

fn spec.initProvider.autoscalingPolicy.cpuUtilization.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

obj spec.initProvider.autoscalingPolicy.loadBalancingUtilization

"Configuration parameters of autoscaling based on a load balancer. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.loadBalancingUtilization.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

obj spec.initProvider.autoscalingPolicy.metric

"Configuration parameters of autoscaling based on a custom metric. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.metric.withName

withName(name)

"The identifier for this object. Format specified above."

fn spec.initProvider.autoscalingPolicy.metric.withTarget

withTarget(target)

"URL of the managed instance group that this autoscaler will scale."

fn spec.initProvider.autoscalingPolicy.metric.withType

withType(type)

"Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Possible values are: GAUGE, DELTA_PER_SECOND, DELTA_PER_MINUTE."

obj spec.initProvider.autoscalingPolicy.scaleInControl

"Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below."

fn spec.initProvider.autoscalingPolicy.scaleInControl.withMaxScaledInReplicas

withMaxScaledInReplicas(maxScaledInReplicas)

"A nested object resource Structure is documented below."

fn spec.initProvider.autoscalingPolicy.scaleInControl.withMaxScaledInReplicasMixin

withMaxScaledInReplicasMixin(maxScaledInReplicas)

"A nested object resource Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.autoscalingPolicy.scaleInControl.withTimeWindowSec

withTimeWindowSec(timeWindowSec)

"How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above."

obj spec.initProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas

"A nested object resource Structure is documented below."

fn spec.initProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas.withFixed

withFixed(fixed)

"Specifies a fixed number of VM instances. This must be a positive integer."

fn spec.initProvider.autoscalingPolicy.scaleInControl.maxScaledInReplicas.withPercent

withPercent(percent)

"Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."

obj spec.initProvider.autoscalingPolicy.scalingSchedules

"Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler and they can overlap. Structure is documented below."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withDescription

withDescription(description)

"A description of a scaling schedule."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withDisabled

withDisabled(disabled)

"A boolean value that specifies if a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withDurationSec

withDurationSec(durationSec)

"The duration of time intervals (in seconds) for which this scaling schedule will be running. The minimum allowed value is 300."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withMinRequiredReplicas

withMinRequiredReplicas(minRequiredReplicas)

"Minimum number of VM instances that autoscaler will recommend in time intervals starting according to schedule."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withName

withName(name)

"The identifier for this object. Format specified above."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withSchedule

withSchedule(schedule)

"The start timestamps of time intervals when this scaling schedule should provide a scaling signal. This field uses the extended cron format (with an optional year field)."

fn spec.initProvider.autoscalingPolicy.scalingSchedules.withTimeZone

withTimeZone(timeZone)

"The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database."

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