/******************************************************************************* * 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.EKS; using Amazon.EKS.Model; namespace Amazon.PowerShell.Cmdlets.EKS { /// /// Connects a Kubernetes cluster to the Amazon EKS control plane. /// /// /// /// Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current /// information about the cluster and its nodes. /// /// Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane. /// /// Second, a Manifest /// containing the activationID and activationCode must be applied /// to the Kubernetes cluster through it's native provider to provide visibility. /// /// After the Manifest is updated and applied, then the connected cluster is visible to /// the Amazon EKS control plane. If the Manifest is not applied within three days, then /// the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster. /// /// [Cmdlet("Register", "EKSCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EKS.Model.Cluster")] [AWSCmdlet("Calls the Amazon Elastic Container Service for Kubernetes RegisterCluster API operation.", Operation = new[] {"RegisterCluster"}, SelectReturnType = typeof(Amazon.EKS.Model.RegisterClusterResponse))] [AWSCmdletOutput("Amazon.EKS.Model.Cluster or Amazon.EKS.Model.RegisterClusterResponse", "This cmdlet returns an Amazon.EKS.Model.Cluster object.", "The service call response (type Amazon.EKS.Model.RegisterClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RegisterEKSClusterCmdlet : AmazonEKSClientCmdlet, IExecutor { #region Parameter ClientRequestToken /// /// /// Unique, case-sensitive identifier that you provide to ensure the idempotency of the /// request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter Name /// /// /// Define a unique name for this cluster for your Region. /// /// #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 ConnectorConfig_Provider /// /// /// The cloud provider for the target cluster to connect. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.EKS.ConnectorConfigProvider")] public Amazon.EKS.ConnectorConfigProvider ConnectorConfig_Provider { get; set; } #endregion #region Parameter ConnectorConfig_RoleArn /// /// /// The Amazon Resource Name (ARN) of the role that is authorized to request the connector /// configuration. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ConnectorConfig_RoleArn { get; set; } #endregion #region Parameter Tag /// /// /// The metadata that you apply to the cluster to assist with categorization and organization. /// Each tag consists of a key and an optional value, both of which you define. Cluster /// tags do not propagate to any other resources associated with the cluster. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public System.Collections.Hashtable Tag { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.RegisterClusterResponse). /// Specifying the name of a property of type Amazon.EKS.Model.RegisterClusterResponse will result in that property being returned. /// 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; } = "Cluster"; #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, "Register-EKSCluster (RegisterCluster)")) { 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 context.ClientRequestToken = this.ClientRequestToken; context.ConnectorConfig_Provider = this.ConnectorConfig_Provider; #if MODULAR if (this.ConnectorConfig_Provider == null && ParameterWasBound(nameof(this.ConnectorConfig_Provider))) { WriteWarning("You are passing $null as a value for parameter ConnectorConfig_Provider 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.ConnectorConfig_RoleArn = this.ConnectorConfig_RoleArn; #if MODULAR if (this.ConnectorConfig_RoleArn == null && ParameterWasBound(nameof(this.ConnectorConfig_RoleArn))) { WriteWarning("You are passing $null as a value for parameter ConnectorConfig_RoleArn 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.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 if (this.Tag != null) { context.Tag = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Tag.Keys) { context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey])); } } // 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.EKS.Model.RegisterClusterRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } // populate ConnectorConfig var requestConnectorConfigIsNull = true; request.ConnectorConfig = new Amazon.EKS.Model.ConnectorConfigRequest(); Amazon.EKS.ConnectorConfigProvider requestConnectorConfig_connectorConfig_Provider = null; if (cmdletContext.ConnectorConfig_Provider != null) { requestConnectorConfig_connectorConfig_Provider = cmdletContext.ConnectorConfig_Provider; } if (requestConnectorConfig_connectorConfig_Provider != null) { request.ConnectorConfig.Provider = requestConnectorConfig_connectorConfig_Provider; requestConnectorConfigIsNull = false; } System.String requestConnectorConfig_connectorConfig_RoleArn = null; if (cmdletContext.ConnectorConfig_RoleArn != null) { requestConnectorConfig_connectorConfig_RoleArn = cmdletContext.ConnectorConfig_RoleArn; } if (requestConnectorConfig_connectorConfig_RoleArn != null) { request.ConnectorConfig.RoleArn = requestConnectorConfig_connectorConfig_RoleArn; requestConnectorConfigIsNull = false; } // determine if request.ConnectorConfig should be set to null if (requestConnectorConfigIsNull) { request.ConnectorConfig = null; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.EKS.Model.RegisterClusterResponse CallAWSServiceOperation(IAmazonEKS client, Amazon.EKS.Model.RegisterClusterRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Container Service for Kubernetes", "RegisterCluster"); try { #if DESKTOP return client.RegisterCluster(request); #elif CORECLR return client.RegisterClusterAsync(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 System.String ClientRequestToken { get; set; } public Amazon.EKS.ConnectorConfigProvider ConnectorConfig_Provider { get; set; } public System.String ConnectorConfig_RoleArn { get; set; } public System.String Name { get; set; } public Dictionary Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Cluster; } } }