AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Glue CreateCrawler API operation.

Syntax

New-GLUECrawler
-Name <String>
-LakeFormationConfiguration_AccountId <String>
-Classifier <String[]>
-Configuration <String>
-LineageConfiguration_CrawlerLineageSetting <CrawlerLineageSettings>
-CrawlerSecurityConfiguration <String>
-DatabaseName <String>
-Description <String>
-RecrawlPolicy_RecrawlBehavior <RecrawlBehavior>
-Role <String>
-Schedule <String>
-SchemaChangePolicy <SchemaChangePolicy>
-TablePrefix <String>
-Tag <Hashtable>
-Target <CrawlerTargets>
-LakeFormationConfiguration_UseLakeFormationCredential <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonGlueConfig>

Description

Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.

Parameters

-Classifier <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClassifiers
-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration <String>
Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CrawlerSecurityConfiguration <String>
The name of the SecurityConfiguration structure to be used by this crawler.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabaseName <String>
The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the new crawler.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LakeFormationConfiguration_AccountId <String>
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LakeFormationConfiguration_UseLakeFormationCredential <Boolean>
Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLakeFormationConfiguration_UseLakeFormationCredentials
-LineageConfiguration_CrawlerLineageSetting <CrawlerLineageSettings>
Specifies whether data lineage is enabled for the crawler. Valid values are:
  • ENABLE: enables data lineage for the crawler
  • DISABLE: disables data lineage for the crawler
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLineageConfiguration_CrawlerLineageSettings
-Name <String>
Name of the new crawler.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecrawlPolicy_RecrawlBehavior <RecrawlBehavior>
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Role <String>
The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule <String>
A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchemaChangePolicy <SchemaChangePolicy>
The policy for the crawler's update and deletion behavior.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.CreateCrawlerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TablePrefix <String>
The table prefix used for catalog tables that are created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
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 in the developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Target <CrawlerTargets>
A list of collection of targets to crawl.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargets

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.Glue.Model.CreateCrawlerResponse
This cmdlet does not generate any output.The service response (type Amazon.Glue.Model.CreateCrawlerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Resources
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z