Skip to content

datafusion.v1beta1.instance

"Instance is the Schema for the Instances API. Represents a Data Fusion instance."

Index

Fields

fn new

new(name)

new returns an instance of Instance

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

"InstanceSpec defines the desired state of Instance"

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

withAccelerators(accelerators)

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

fn spec.forProvider.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withCryptoKeyConfig

withCryptoKeyConfig(cryptoKeyConfig)

"The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. Structure is documented below."

fn spec.forProvider.withCryptoKeyConfigMixin

withCryptoKeyConfigMixin(cryptoKeyConfig)

"The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDataprocServiceAccount

withDataprocServiceAccount(dataprocServiceAccount)

"User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines."

fn spec.forProvider.withDescription

withDescription(description)

"An optional description of the instance."

fn spec.forProvider.withDisplayName

withDisplayName(displayName)

"Display name for an instance."

fn spec.forProvider.withEnableRbac

withEnableRbac(enableRbac)

"Option to enable granular role-based access control."

fn spec.forProvider.withEnableStackdriverLogging

withEnableStackdriverLogging(enableStackdriverLogging)

"Option to enable Stackdriver Logging."

fn spec.forProvider.withEnableStackdriverMonitoring

withEnableStackdriverMonitoring(enableStackdriverMonitoring)

"Option to enable Stackdriver Monitoring."

fn spec.forProvider.withEventPublishConfig

withEventPublishConfig(eventPublishConfig)

"Option to enable and pass metadata for event publishing. Structure is documented below."

fn spec.forProvider.withEventPublishConfigMixin

withEventPublishConfigMixin(eventPublishConfig)

"Option to enable and pass metadata for event publishing. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withLabels

withLabels(labels)

"The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs."

fn spec.forProvider.withLabelsMixin

withLabelsMixin(labels)

"The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs."

Note: This function appends passed data to existing values

fn spec.forProvider.withNetworkConfig

withNetworkConfig(networkConfig)

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

fn spec.forProvider.withNetworkConfigMixin

withNetworkConfigMixin(networkConfig)

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withOptions

withOptions(options)

"Map of additional options used to configure the behavior of Data Fusion instance."

fn spec.forProvider.withOptionsMixin

withOptionsMixin(options)

"Map of additional options used to configure the behavior of Data Fusion instance."

Note: This function appends passed data to existing values

fn spec.forProvider.withPrivateInstance

withPrivateInstance(privateInstance)

"Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet."

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)

"The region of the Data Fusion instance."

fn spec.forProvider.withType

withType(type)

"Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory."

fn spec.forProvider.withVersion

withVersion(version)

"Current version of the Data Fusion."

fn spec.forProvider.withZone

withZone(zone)

"Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field."

obj spec.forProvider.accelerators

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

fn spec.forProvider.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"The type of an accelator for a CDF instance. Possible values are: CDC, HEALTHCARE, CCAI_INSIGHTS."

fn spec.forProvider.accelerators.withState

withState(state)

"The type of an accelator for a CDF instance. Possible values are: ENABLED, DISABLED."

obj spec.forProvider.cryptoKeyConfig

"The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. Structure is documented below."

fn spec.forProvider.cryptoKeyConfig.withKeyReference

withKeyReference(keyReference)

"The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects//locations//keyRings//cryptoKeys/."

obj spec.forProvider.cryptoKeyConfig.keyReferenceRef

"Reference to a CryptoKey in kms to populate keyReference."

fn spec.forProvider.cryptoKeyConfig.keyReferenceRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.cryptoKeyConfig.keyReferenceRef.policy

"Policies for referencing."

fn spec.forProvider.cryptoKeyConfig.keyReferenceRef.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.cryptoKeyConfig.keyReferenceRef.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.cryptoKeyConfig.keyReferenceSelector

"Selector for a CryptoKey in kms to populate keyReference."

fn spec.forProvider.cryptoKeyConfig.keyReferenceSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.cryptoKeyConfig.keyReferenceSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.cryptoKeyConfig.keyReferenceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.cryptoKeyConfig.keyReferenceSelector.policy

"Policies for selection."

fn spec.forProvider.cryptoKeyConfig.keyReferenceSelector.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.cryptoKeyConfig.keyReferenceSelector.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.eventPublishConfig

"Option to enable and pass metadata for event publishing. Structure is documented below."

fn spec.forProvider.eventPublishConfig.withEnabled

withEnabled(enabled)

"Option to enable Event Publishing."

fn spec.forProvider.eventPublishConfig.withTopic

withTopic(topic)

"The resource name of the Pub/Sub topic. Format: projects/{projectId}/topics/{topic_id}"

obj spec.forProvider.eventPublishConfig.topicRef

"Reference to a Topic in pubsub to populate topic."

fn spec.forProvider.eventPublishConfig.topicRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.eventPublishConfig.topicRef.policy

"Policies for referencing."

fn spec.forProvider.eventPublishConfig.topicRef.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.eventPublishConfig.topicRef.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.eventPublishConfig.topicSelector

"Selector for a Topic in pubsub to populate topic."

fn spec.forProvider.eventPublishConfig.topicSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.eventPublishConfig.topicSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.eventPublishConfig.topicSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.eventPublishConfig.topicSelector.policy

"Policies for selection."

fn spec.forProvider.eventPublishConfig.topicSelector.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.eventPublishConfig.topicSelector.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.networkConfig

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

fn spec.forProvider.networkConfig.withIpAllocation

withIpAllocation(ipAllocation)

"The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network."

fn spec.forProvider.networkConfig.withNetwork

withNetwork(network)

"Name of the network in the project with which the tenant project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}"

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

withAccelerators(accelerators)

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

fn spec.initProvider.withAcceleratorsMixin

withAcceleratorsMixin(accelerators)

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withCryptoKeyConfig

withCryptoKeyConfig(cryptoKeyConfig)

"The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. Structure is documented below."

fn spec.initProvider.withCryptoKeyConfigMixin

withCryptoKeyConfigMixin(cryptoKeyConfig)

"The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withDataprocServiceAccount

withDataprocServiceAccount(dataprocServiceAccount)

"User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines."

fn spec.initProvider.withDescription

withDescription(description)

"An optional description of the instance."

fn spec.initProvider.withDisplayName

withDisplayName(displayName)

"Display name for an instance."

fn spec.initProvider.withEnableRbac

withEnableRbac(enableRbac)

"Option to enable granular role-based access control."

fn spec.initProvider.withEnableStackdriverLogging

withEnableStackdriverLogging(enableStackdriverLogging)

"Option to enable Stackdriver Logging."

fn spec.initProvider.withEnableStackdriverMonitoring

withEnableStackdriverMonitoring(enableStackdriverMonitoring)

"Option to enable Stackdriver Monitoring."

fn spec.initProvider.withEventPublishConfig

withEventPublishConfig(eventPublishConfig)

"Option to enable and pass metadata for event publishing. Structure is documented below."

fn spec.initProvider.withEventPublishConfigMixin

withEventPublishConfigMixin(eventPublishConfig)

"Option to enable and pass metadata for event publishing. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withLabels

withLabels(labels)

"The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs."

fn spec.initProvider.withLabelsMixin

withLabelsMixin(labels)

"The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs."

Note: This function appends passed data to existing values

fn spec.initProvider.withNetworkConfig

withNetworkConfig(networkConfig)

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

fn spec.initProvider.withNetworkConfigMixin

withNetworkConfigMixin(networkConfig)

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withOptions

withOptions(options)

"Map of additional options used to configure the behavior of Data Fusion instance."

fn spec.initProvider.withOptionsMixin

withOptionsMixin(options)

"Map of additional options used to configure the behavior of Data Fusion instance."

Note: This function appends passed data to existing values

fn spec.initProvider.withPrivateInstance

withPrivateInstance(privateInstance)

"Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet."

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

withType(type)

"Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory."

fn spec.initProvider.withVersion

withVersion(version)

"Current version of the Data Fusion."

fn spec.initProvider.withZone

withZone(zone)

"Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field."

obj spec.initProvider.accelerators

"List of accelerators enabled for this CDF instance. If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a lifecycle ignore changes block. Structure is documented below."

fn spec.initProvider.accelerators.withAcceleratorType

withAcceleratorType(acceleratorType)

"The type of an accelator for a CDF instance. Possible values are: CDC, HEALTHCARE, CCAI_INSIGHTS."

fn spec.initProvider.accelerators.withState

withState(state)

"The type of an accelator for a CDF instance. Possible values are: ENABLED, DISABLED."

obj spec.initProvider.eventPublishConfig

"Option to enable and pass metadata for event publishing. Structure is documented below."

fn spec.initProvider.eventPublishConfig.withEnabled

withEnabled(enabled)

"Option to enable Event Publishing."

obj spec.initProvider.networkConfig

"Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below."

fn spec.initProvider.networkConfig.withIpAllocation

withIpAllocation(ipAllocation)

"The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network."

fn spec.initProvider.networkConfig.withNetwork

withNetwork(network)

"Name of the network in the project with which the tenant project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}"

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