Skip to content

glue.v1alpha1.crawler

"Crawler is the Schema for the Crawlers API"

Index

Fields

fn new

new(name)

new returns an instance of Crawler

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

"CrawlerSpec defines the desired state of Crawler"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

obj spec.forProvider

"CrawlerParameters defines the desired state of Crawler"

fn spec.forProvider.withClassifierRefs

withClassifierRefs(classifierRefs)

"ClassifierRefs is a list of references to Classifiers used to set the Classifiers."

fn spec.forProvider.withClassifierRefsMixin

withClassifierRefsMixin(classifierRefs)

"ClassifierRefs is a list of references to Classifiers used to set the Classifiers."

Note: This function appends passed data to existing values

fn spec.forProvider.withClassifiers

withClassifiers(classifiers)

"A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification."

fn spec.forProvider.withClassifiersMixin

withClassifiersMixin(classifiers)

"A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification."

Note: This function appends passed data to existing values

fn spec.forProvider.withConfiguration

withConfiguration(configuration)

"Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)."

fn spec.forProvider.withCrawlerSecurityConfiguration

withCrawlerSecurityConfiguration(crawlerSecurityConfiguration)

"The name of the SecurityConfiguration structure to be used by this crawler."

fn spec.forProvider.withDatabaseName

withDatabaseName(databaseName)

"The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*."

fn spec.forProvider.withDescription

withDescription(description)

"A description of the new crawler."

fn spec.forProvider.withRegion

withRegion(region)

"Region is which region the Crawler will be created."

fn spec.forProvider.withRole

withRole(role)

"The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources. AWS API seems to give just name of the role back (not ARN)"

fn spec.forProvider.withSchedule

withSchedule(schedule)

"A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *)."

fn spec.forProvider.withTablePrefix

withTablePrefix(tablePrefix)

"The table prefix used for catalog tables that are created."

fn spec.forProvider.withTags

withTags(tags)

"The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer guide."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer guide."

Note: This function appends passed data to existing values

obj spec.forProvider.classifierRefs

"ClassifierRefs is a list of references to Classifiers used to set the Classifiers."

fn spec.forProvider.classifierRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.classifierRefs.policy

"Policies for referencing."

fn spec.forProvider.classifierRefs.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.classifierRefs.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.classifierSelector

"ClassifiersSelector selects references to Classifiers used to set the Classifiers."

fn spec.forProvider.classifierSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.classifierSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.classifierSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.classifierSelector.policy

"Policies for selection."

fn spec.forProvider.classifierSelector.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.classifierSelector.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.crawlerSecurityConfigurationRef

"CrawlerSecurityConfigurationRef is a reference to an SecurityConfiguration used to set the CrawlerSecurityConfiguration."

fn spec.forProvider.crawlerSecurityConfigurationRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.crawlerSecurityConfigurationRef.policy

"Policies for referencing."

fn spec.forProvider.crawlerSecurityConfigurationRef.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.crawlerSecurityConfigurationRef.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.crawlerSecurityConfigurationSelector

"CrawlerSecurityConfigurationSelector selects references to SecurityConfiguration used to set the CrawlerSecurityConfiguration."

fn spec.forProvider.crawlerSecurityConfigurationSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.crawlerSecurityConfigurationSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.crawlerSecurityConfigurationSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.crawlerSecurityConfigurationSelector.policy

"Policies for selection."

fn spec.forProvider.crawlerSecurityConfigurationSelector.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.crawlerSecurityConfigurationSelector.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.databaseNameRef

"DatabaseNameRef is a reference to an Database used to set the DatabaseName."

fn spec.forProvider.databaseNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.databaseNameRef.policy

"Policies for referencing."

fn spec.forProvider.databaseNameRef.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.databaseNameRef.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.databaseNameSelector

"DatabaseNamesSelector selects references to Database used to set the DatabaseName."

fn spec.forProvider.databaseNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.databaseNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.databaseNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.databaseNameSelector.policy

"Policies for selection."

fn spec.forProvider.databaseNameSelector.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.databaseNameSelector.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.lakeFormationConfiguration

fn spec.forProvider.lakeFormationConfiguration.withAccountID

withAccountID(accountID)

fn spec.forProvider.lakeFormationConfiguration.withUseLakeFormationCredentials

withUseLakeFormationCredentials(useLakeFormationCredentials)

obj spec.forProvider.lineageConfiguration

"Specifies data lineage configuration settings for the crawler."

fn spec.forProvider.lineageConfiguration.withCrawlerLineageSettings

withCrawlerLineageSettings(crawlerLineageSettings)

obj spec.forProvider.recrawlPolicy

"A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run."

fn spec.forProvider.recrawlPolicy.withRecrawlBehavior

withRecrawlBehavior(recrawlBehavior)

obj spec.forProvider.roleRef

"RoleRef is a reference to an IAMRole used to set the Role."

fn spec.forProvider.roleRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.roleRef.policy

"Policies for referencing."

fn spec.forProvider.roleRef.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.roleRef.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.roleSelector

"RoleSelector selects references to IAMRole used to set the Role."

fn spec.forProvider.roleSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.roleSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.roleSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.roleSelector.policy

"Policies for selection."

fn spec.forProvider.roleSelector.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.roleSelector.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.schemaChangePolicy

"The policy for the crawler's update and deletion behavior."

fn spec.forProvider.schemaChangePolicy.withDeleteBehavior

withDeleteBehavior(deleteBehavior)

fn spec.forProvider.schemaChangePolicy.withUpdateBehavior

withUpdateBehavior(updateBehavior)

obj spec.forProvider.targets

"A list of collection of targets to crawl. \n Targets is a required field"

fn spec.forProvider.targets.withCatalogTargets

withCatalogTargets(catalogTargets)

"Specifies Glue Data Catalog targets."

fn spec.forProvider.targets.withCatalogTargetsMixin

withCatalogTargetsMixin(catalogTargets)

"Specifies Glue Data Catalog targets."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.withDynamoDBTargets

withDynamoDBTargets(dynamoDBTargets)

"Specifies Amazon DynamoDB targets."

fn spec.forProvider.targets.withDynamoDBTargetsMixin

withDynamoDBTargetsMixin(dynamoDBTargets)

"Specifies Amazon DynamoDB targets."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.withJdbcTargets

withJdbcTargets(jdbcTargets)

"Specifies JDBC targets."

fn spec.forProvider.targets.withJdbcTargetsMixin

withJdbcTargetsMixin(jdbcTargets)

"Specifies JDBC targets."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.withMongoDBTargets

withMongoDBTargets(mongoDBTargets)

"Specifies Amazon DocumentDB or MongoDB targets."

fn spec.forProvider.targets.withMongoDBTargetsMixin

withMongoDBTargetsMixin(mongoDBTargets)

"Specifies Amazon DocumentDB or MongoDB targets."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.withS3Targets

withS3Targets(s3Targets)

"Specifies Amazon Simple Storage Service (Amazon S3) targets."

fn spec.forProvider.targets.withS3TargetsMixin

withS3TargetsMixin(s3Targets)

"Specifies Amazon Simple Storage Service (Amazon S3) targets."

Note: This function appends passed data to existing values

obj spec.forProvider.targets.catalogTargets

"Specifies Glue Data Catalog targets."

fn spec.forProvider.targets.catalogTargets.withDatabaseName

withDatabaseName(databaseName)

"The name of the database to be synchronized. \n DatabaseName is a required field"

fn spec.forProvider.targets.catalogTargets.withTables

withTables(tables)

"A list of the tables to be synchronized. \n Tables is a required field"

fn spec.forProvider.targets.catalogTargets.withTablesMixin

withTablesMixin(tables)

"A list of the tables to be synchronized. \n Tables is a required field"

Note: This function appends passed data to existing values

obj spec.forProvider.targets.catalogTargets.databaseNameRef

"DatabaseNameRef is a reference to an Database used to set the DatabaseName."

fn spec.forProvider.targets.catalogTargets.databaseNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.catalogTargets.databaseNameRef.policy

"Policies for referencing."

fn spec.forProvider.targets.catalogTargets.databaseNameRef.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.targets.catalogTargets.databaseNameRef.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.targets.catalogTargets.databaseNameSelector

"DatabaseNamesSelector selects references to Database used to set the DatabaseName."

fn spec.forProvider.targets.catalogTargets.databaseNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.catalogTargets.databaseNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.catalogTargets.databaseNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.catalogTargets.databaseNameSelector.policy

"Policies for selection."

fn spec.forProvider.targets.catalogTargets.databaseNameSelector.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.targets.catalogTargets.databaseNameSelector.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.targets.dynamoDBTargets

"Specifies Amazon DynamoDB targets."

fn spec.forProvider.targets.dynamoDBTargets.withPath

withPath(path)

fn spec.forProvider.targets.dynamoDBTargets.withScanAll

withScanAll(scanAll)

fn spec.forProvider.targets.dynamoDBTargets.withScanRate

withScanRate(scanRate)

obj spec.forProvider.targets.jdbcTargets

"Specifies JDBC targets."

fn spec.forProvider.targets.jdbcTargets.withConnectionName

withConnectionName(connectionName)

"The name of the connection to use to connect to the JDBC target."

fn spec.forProvider.targets.jdbcTargets.withExclusions

withExclusions(exclusions)

"A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)."

fn spec.forProvider.targets.jdbcTargets.withExclusionsMixin

withExclusionsMixin(exclusions)

"A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.jdbcTargets.withPath

withPath(path)

"The path of the JDBC target."

obj spec.forProvider.targets.jdbcTargets.connectionNameRef

"ConnectionNameRef is a reference to an Connection used to set the ConnectionName."

fn spec.forProvider.targets.jdbcTargets.connectionNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.jdbcTargets.connectionNameRef.policy

"Policies for referencing."

fn spec.forProvider.targets.jdbcTargets.connectionNameRef.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.targets.jdbcTargets.connectionNameRef.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.targets.jdbcTargets.connectionNameSelector

"ConnectionNamesSelector selects references to Connection used to set the ConnectionName."

fn spec.forProvider.targets.jdbcTargets.connectionNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.jdbcTargets.connectionNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.jdbcTargets.connectionNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.jdbcTargets.connectionNameSelector.policy

"Policies for selection."

fn spec.forProvider.targets.jdbcTargets.connectionNameSelector.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.targets.jdbcTargets.connectionNameSelector.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.targets.mongoDBTargets

"Specifies Amazon DocumentDB or MongoDB targets."

fn spec.forProvider.targets.mongoDBTargets.withConnectionName

withConnectionName(connectionName)

"The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target."

fn spec.forProvider.targets.mongoDBTargets.withPath

withPath(path)

"The path of the Amazon DocumentDB or MongoDB target (database/collection)."

fn spec.forProvider.targets.mongoDBTargets.withScanAll

withScanAll(scanAll)

"Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table. \n A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true."

obj spec.forProvider.targets.mongoDBTargets.connectionNameRef

"ConnectionNameRef is a reference to an Connection used to set the ConnectionName."

fn spec.forProvider.targets.mongoDBTargets.connectionNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.mongoDBTargets.connectionNameRef.policy

"Policies for referencing."

fn spec.forProvider.targets.mongoDBTargets.connectionNameRef.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.targets.mongoDBTargets.connectionNameRef.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.targets.mongoDBTargets.connectionNameSelector

"ConnectionNamesSelector selects references to Connection used to set the ConnectionName."

fn spec.forProvider.targets.mongoDBTargets.connectionNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.mongoDBTargets.connectionNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.mongoDBTargets.connectionNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.mongoDBTargets.connectionNameSelector.policy

"Policies for selection."

fn spec.forProvider.targets.mongoDBTargets.connectionNameSelector.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.targets.mongoDBTargets.connectionNameSelector.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.targets.s3Targets

"Specifies Amazon Simple Storage Service (Amazon S3) targets."

fn spec.forProvider.targets.s3Targets.withConnectionName

withConnectionName(connectionName)

"The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC)."

fn spec.forProvider.targets.s3Targets.withDlqEventQueueArn

withDlqEventQueueArn(dlqEventQueueArn)

"A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue."

fn spec.forProvider.targets.s3Targets.withEventQueueArn

withEventQueueArn(eventQueueArn)

"A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs."

fn spec.forProvider.targets.s3Targets.withExclusions

withExclusions(exclusions)

"A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)."

fn spec.forProvider.targets.s3Targets.withExclusionsMixin

withExclusionsMixin(exclusions)

"A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)."

Note: This function appends passed data to existing values

fn spec.forProvider.targets.s3Targets.withPath

withPath(path)

"The path to the Amazon S3 target."

fn spec.forProvider.targets.s3Targets.withSampleSize

withSampleSize(sampleSize)

"Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249."

obj spec.forProvider.targets.s3Targets.connectionNameRef

"ConnectionNameRef is a reference to an Connection used to set the ConnectionName."

fn spec.forProvider.targets.s3Targets.connectionNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.s3Targets.connectionNameRef.policy

"Policies for referencing."

fn spec.forProvider.targets.s3Targets.connectionNameRef.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.targets.s3Targets.connectionNameRef.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.targets.s3Targets.connectionNameSelector

"ConnectionNamesSelector selects references to Connection used to set the ConnectionName."

fn spec.forProvider.targets.s3Targets.connectionNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.s3Targets.connectionNameSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.s3Targets.connectionNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.s3Targets.connectionNameSelector.policy

"Policies for selection."

fn spec.forProvider.targets.s3Targets.connectionNameSelector.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.targets.s3Targets.connectionNameSelector.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.targets.s3Targets.dlqEventQueueArnRef

"DlqEventQueueARNRef is a reference to an SQSEventQueue used to set the DlqEventQueueARN."

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.s3Targets.dlqEventQueueArnRef.policy

"Policies for referencing."

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnRef.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.targets.s3Targets.dlqEventQueueArnRef.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.targets.s3Targets.dlqEventQueueArnSelector

"DlqEventQueueARNSelector selects references to SQSEventQueue used to set the DlqEventQueueARN."

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.s3Targets.dlqEventQueueArnSelector.policy

"Policies for selection."

fn spec.forProvider.targets.s3Targets.dlqEventQueueArnSelector.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.targets.s3Targets.dlqEventQueueArnSelector.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.targets.s3Targets.eventQueueArnRef

"EventQueueARNRef is a reference to an SQSEventQueue used to set the EventQueueARN."

fn spec.forProvider.targets.s3Targets.eventQueueArnRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.targets.s3Targets.eventQueueArnRef.policy

"Policies for referencing."

fn spec.forProvider.targets.s3Targets.eventQueueArnRef.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.targets.s3Targets.eventQueueArnRef.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.targets.s3Targets.eventQueueArnSelector

"EventQueueARNSelector selects references to SQSEventQueue used to set the EventQueueARN."

fn spec.forProvider.targets.s3Targets.eventQueueArnSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

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

fn spec.forProvider.targets.s3Targets.eventQueueArnSelector.withMatchLabels

withMatchLabels(matchLabels)

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

fn spec.forProvider.targets.s3Targets.eventQueueArnSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

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

Note: This function appends passed data to existing values

obj spec.forProvider.targets.s3Targets.eventQueueArnSelector.policy

"Policies for selection."

fn spec.forProvider.targets.s3Targets.eventQueueArnSelector.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.targets.s3Targets.eventQueueArnSelector.policy.withResolve

withResolve(resolve)

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

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

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

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

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

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

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

fn spec.providerRef.policy.withResolve

withResolve(resolve)

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

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

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

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

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

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."