/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.Glue; using Amazon.Glue.Model; namespace Amazon.PowerShell.Cmdlets.GLUE { /// /// Updates a crawler. If a crawler is running, you must stop it using StopCrawler /// before updating it. /// [Cmdlet("Update", "GLUECrawler", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Glue UpdateCrawler API operation.", Operation = new[] {"UpdateCrawler"}, SelectReturnType = typeof(Amazon.Glue.Model.UpdateCrawlerResponse))] [AWSCmdletOutput("None or Amazon.Glue.Model.UpdateCrawlerResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.Glue.Model.UpdateCrawlerResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateGLUECrawlerCmdlet : AmazonGlueClientCmdlet, IExecutor { #region Parameter LakeFormationConfiguration_AccountId /// /// /// Required for cross account crawls. For same account crawls as the target data, this /// can be left as null. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LakeFormationConfiguration_AccountId { get; set; } #endregion #region Parameter Classifier /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Classifiers")] public System.String[] Classifier { get; set; } #endregion #region Parameter Configuration /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Configuration { get; set; } #endregion #region Parameter LineageConfiguration_CrawlerLineageSetting /// /// /// Specifies whether data lineage is enabled for the crawler. Valid values are: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LineageConfiguration_CrawlerLineageSettings")] [AWSConstantClassSource("Amazon.Glue.CrawlerLineageSettings")] public Amazon.Glue.CrawlerLineageSettings LineageConfiguration_CrawlerLineageSetting { get; set; } #endregion #region Parameter CrawlerSecurityConfiguration /// /// /// The name of the SecurityConfiguration structure to be used by this crawler. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String CrawlerSecurityConfiguration { get; set; } #endregion #region Parameter DatabaseName /// /// /// The Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DatabaseName { get; set; } #endregion #region Parameter Description /// /// /// A description of the new crawler. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter Name /// /// /// Name of the new crawler. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter RecrawlPolicy_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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Glue.RecrawlBehavior")] public Amazon.Glue.RecrawlBehavior RecrawlPolicy_RecrawlBehavior { get; set; } #endregion #region Parameter Role /// /// /// The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new /// crawler to access customer resources. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Role { get; set; } #endregion #region Parameter Schedule /// /// /// 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 * * ? *). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Schedule { get; set; } #endregion #region Parameter SchemaChangePolicy /// /// /// The policy for the crawler's update and deletion behavior. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.Glue.Model.SchemaChangePolicy SchemaChangePolicy { get; set; } #endregion #region Parameter TablePrefix /// /// /// The table prefix used for catalog tables that are created. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TablePrefix { get; set; } #endregion #region Parameter Target /// /// /// A list of targets to crawl. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Targets")] public Amazon.Glue.Model.CrawlerTargets Target { get; set; } #endregion #region Parameter LakeFormationConfiguration_UseLakeFormationCredential /// /// /// Specifies whether to use Lake Formation credentials for the crawler instead of the /// IAM role credentials. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LakeFormationConfiguration_UseLakeFormationCredentials")] public System.Boolean? LakeFormationConfiguration_UseLakeFormationCredential { get; set; } #endregion #region Parameter Select /// /// 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.UpdateCrawlerResponse). /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// 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. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-GLUECrawler (UpdateCrawler)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.Classifier != null) { context.Classifier = new List(this.Classifier); } context.Configuration = this.Configuration; context.CrawlerSecurityConfiguration = this.CrawlerSecurityConfiguration; context.DatabaseName = this.DatabaseName; context.Description = this.Description; context.LakeFormationConfiguration_AccountId = this.LakeFormationConfiguration_AccountId; context.LakeFormationConfiguration_UseLakeFormationCredential = this.LakeFormationConfiguration_UseLakeFormationCredential; context.LineageConfiguration_CrawlerLineageSetting = this.LineageConfiguration_CrawlerLineageSetting; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.RecrawlPolicy_RecrawlBehavior = this.RecrawlPolicy_RecrawlBehavior; context.Role = this.Role; context.Schedule = this.Schedule; context.SchemaChangePolicy = this.SchemaChangePolicy; context.TablePrefix = this.TablePrefix; context.Target = this.Target; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.Glue.Model.UpdateCrawlerRequest(); if (cmdletContext.Classifier != null) { request.Classifiers = cmdletContext.Classifier; } if (cmdletContext.Configuration != null) { request.Configuration = cmdletContext.Configuration; } if (cmdletContext.CrawlerSecurityConfiguration != null) { request.CrawlerSecurityConfiguration = cmdletContext.CrawlerSecurityConfiguration; } if (cmdletContext.DatabaseName != null) { request.DatabaseName = cmdletContext.DatabaseName; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } // populate LakeFormationConfiguration var requestLakeFormationConfigurationIsNull = true; request.LakeFormationConfiguration = new Amazon.Glue.Model.LakeFormationConfiguration(); System.String requestLakeFormationConfiguration_lakeFormationConfiguration_AccountId = null; if (cmdletContext.LakeFormationConfiguration_AccountId != null) { requestLakeFormationConfiguration_lakeFormationConfiguration_AccountId = cmdletContext.LakeFormationConfiguration_AccountId; } if (requestLakeFormationConfiguration_lakeFormationConfiguration_AccountId != null) { request.LakeFormationConfiguration.AccountId = requestLakeFormationConfiguration_lakeFormationConfiguration_AccountId; requestLakeFormationConfigurationIsNull = false; } System.Boolean? requestLakeFormationConfiguration_lakeFormationConfiguration_UseLakeFormationCredential = null; if (cmdletContext.LakeFormationConfiguration_UseLakeFormationCredential != null) { requestLakeFormationConfiguration_lakeFormationConfiguration_UseLakeFormationCredential = cmdletContext.LakeFormationConfiguration_UseLakeFormationCredential.Value; } if (requestLakeFormationConfiguration_lakeFormationConfiguration_UseLakeFormationCredential != null) { request.LakeFormationConfiguration.UseLakeFormationCredentials = requestLakeFormationConfiguration_lakeFormationConfiguration_UseLakeFormationCredential.Value; requestLakeFormationConfigurationIsNull = false; } // determine if request.LakeFormationConfiguration should be set to null if (requestLakeFormationConfigurationIsNull) { request.LakeFormationConfiguration = null; } // populate LineageConfiguration var requestLineageConfigurationIsNull = true; request.LineageConfiguration = new Amazon.Glue.Model.LineageConfiguration(); Amazon.Glue.CrawlerLineageSettings requestLineageConfiguration_lineageConfiguration_CrawlerLineageSetting = null; if (cmdletContext.LineageConfiguration_CrawlerLineageSetting != null) { requestLineageConfiguration_lineageConfiguration_CrawlerLineageSetting = cmdletContext.LineageConfiguration_CrawlerLineageSetting; } if (requestLineageConfiguration_lineageConfiguration_CrawlerLineageSetting != null) { request.LineageConfiguration.CrawlerLineageSettings = requestLineageConfiguration_lineageConfiguration_CrawlerLineageSetting; requestLineageConfigurationIsNull = false; } // determine if request.LineageConfiguration should be set to null if (requestLineageConfigurationIsNull) { request.LineageConfiguration = null; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } // populate RecrawlPolicy var requestRecrawlPolicyIsNull = true; request.RecrawlPolicy = new Amazon.Glue.Model.RecrawlPolicy(); Amazon.Glue.RecrawlBehavior requestRecrawlPolicy_recrawlPolicy_RecrawlBehavior = null; if (cmdletContext.RecrawlPolicy_RecrawlBehavior != null) { requestRecrawlPolicy_recrawlPolicy_RecrawlBehavior = cmdletContext.RecrawlPolicy_RecrawlBehavior; } if (requestRecrawlPolicy_recrawlPolicy_RecrawlBehavior != null) { request.RecrawlPolicy.RecrawlBehavior = requestRecrawlPolicy_recrawlPolicy_RecrawlBehavior; requestRecrawlPolicyIsNull = false; } // determine if request.RecrawlPolicy should be set to null if (requestRecrawlPolicyIsNull) { request.RecrawlPolicy = null; } if (cmdletContext.Role != null) { request.Role = cmdletContext.Role; } if (cmdletContext.Schedule != null) { request.Schedule = cmdletContext.Schedule; } if (cmdletContext.SchemaChangePolicy != null) { request.SchemaChangePolicy = cmdletContext.SchemaChangePolicy; } if (cmdletContext.TablePrefix != null) { request.TablePrefix = cmdletContext.TablePrefix; } if (cmdletContext.Target != null) { request.Targets = cmdletContext.Target; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.Glue.Model.UpdateCrawlerResponse CallAWSServiceOperation(IAmazonGlue client, Amazon.Glue.Model.UpdateCrawlerRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Glue", "UpdateCrawler"); try { #if DESKTOP return client.UpdateCrawler(request); #elif CORECLR return client.UpdateCrawlerAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public List Classifier { get; set; } public System.String Configuration { get; set; } public System.String CrawlerSecurityConfiguration { get; set; } public System.String DatabaseName { get; set; } public System.String Description { get; set; } public System.String LakeFormationConfiguration_AccountId { get; set; } public System.Boolean? LakeFormationConfiguration_UseLakeFormationCredential { get; set; } public Amazon.Glue.CrawlerLineageSettings LineageConfiguration_CrawlerLineageSetting { get; set; } public System.String Name { get; set; } public Amazon.Glue.RecrawlBehavior RecrawlPolicy_RecrawlBehavior { get; set; } public System.String Role { get; set; } public System.String Schedule { get; set; } public Amazon.Glue.Model.SchemaChangePolicy SchemaChangePolicy { get; set; } public System.String TablePrefix { get; set; } public Amazon.Glue.Model.CrawlerTargets Target { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }