/******************************************************************************* * 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 { /// /// Creates an Fargate profile for your Amazon EKS cluster. You must have at least one /// Fargate profile in a cluster to be able to run pods on Fargate. /// /// /// /// The Fargate profile allows an administrator to declare which pods run on Fargate and /// specify which pods run on which Fargate profile. This declaration is done through /// the profile’s selectors. Each profile can have up to five selectors that contain a /// namespace and labels. A namespace is required for every selector. The label field /// consists of multiple optional key-value pairs. Pods that match the selectors are scheduled /// on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, /// then that pod is run on Fargate. /// /// When you create a Fargate profile, you must specify a pod execution role to use with /// the pods that are scheduled with the profile. This role is added to the cluster's /// Kubernetes Role Based /// Access Control (RBAC) for authorization so that the kubelet that /// is running on the Fargate infrastructure can register with your Amazon EKS cluster /// so that it can appear in your cluster as a node. The pod execution role also provides /// IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image /// repositories. For more information, see Pod /// Execution Role in the Amazon EKS User Guide. /// /// Fargate profiles are immutable. However, you can create a new updated profile to replace /// an existing profile and then delete the original after the updated profile has finished /// creating. /// /// If any Fargate profiles in a cluster are in the DELETING status, you /// must wait for that Fargate profile to finish deleting before you can create any other /// profiles in that cluster. /// /// For more information, see Fargate /// Profile in the Amazon EKS User Guide. /// /// [Cmdlet("New", "EKSFargateProfile", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EKS.Model.FargateProfile")] [AWSCmdlet("Calls the Amazon Elastic Container Service for Kubernetes CreateFargateProfile API operation.", Operation = new[] {"CreateFargateProfile"}, SelectReturnType = typeof(Amazon.EKS.Model.CreateFargateProfileResponse))] [AWSCmdletOutput("Amazon.EKS.Model.FargateProfile or Amazon.EKS.Model.CreateFargateProfileResponse", "This cmdlet returns an Amazon.EKS.Model.FargateProfile object.", "The service call response (type Amazon.EKS.Model.CreateFargateProfileResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEKSFargateProfileCmdlet : 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 ClusterName /// /// /// The name of the Amazon EKS cluster to apply the Fargate profile to. /// /// #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 ClusterName { get; set; } #endregion #region Parameter FargateProfileName /// /// /// The name of the Fargate profile. /// /// #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 FargateProfileName { get; set; } #endregion #region Parameter PodExecutionRoleArn /// /// /// The Amazon Resource Name (ARN) of the pod execution role to use for pods that match /// the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure /// to register with your cluster as a node, and it provides read access to Amazon ECR /// image repositories. For more information, see Pod /// Execution Role in the Amazon EKS User Guide. /// /// #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 PodExecutionRoleArn { get; set; } #endregion #region Parameter Selector /// /// /// The selectors to match for pods to use this Fargate profile. Each selector must have /// an associated namespace. Optionally, you can also specify labels for a namespace. /// You may specify up to five selectors in a Fargate profile. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Selectors")] public Amazon.EKS.Model.FargateProfileSelector[] Selector { get; set; } #endregion #region Parameter Subnet /// /// /// The IDs of subnets to launch your pods into. At this time, pods running on Fargate /// are not assigned public IP addresses, so only private subnets (with no direct route /// to an Internet Gateway) are accepted for this parameter. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Subnets")] public System.String[] Subnet { get; set; } #endregion #region Parameter Tag /// /// /// The metadata to apply to the Fargate profile to assist with categorization and organization. /// Each tag consists of a key and an optional value. You define both. Fargate profile /// tags do not propagate to any other resources associated with the Fargate profile, /// such as the pods that are scheduled with it. /// /// [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 'FargateProfile'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EKS.Model.CreateFargateProfileResponse). /// Specifying the name of a property of type Amazon.EKS.Model.CreateFargateProfileResponse 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; } = "FargateProfile"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the FargateProfileName parameter. /// The -PassThru parameter is deprecated, use -Select '^FargateProfileName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FargateProfileName' 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.FargateProfileName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EKSFargateProfile (CreateFargateProfile)")) { 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.FargateProfileName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientRequestToken = this.ClientRequestToken; context.ClusterName = this.ClusterName; #if MODULAR if (this.ClusterName == null && ParameterWasBound(nameof(this.ClusterName))) { WriteWarning("You are passing $null as a value for parameter ClusterName 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.FargateProfileName = this.FargateProfileName; #if MODULAR if (this.FargateProfileName == null && ParameterWasBound(nameof(this.FargateProfileName))) { WriteWarning("You are passing $null as a value for parameter FargateProfileName 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.PodExecutionRoleArn = this.PodExecutionRoleArn; #if MODULAR if (this.PodExecutionRoleArn == null && ParameterWasBound(nameof(this.PodExecutionRoleArn))) { WriteWarning("You are passing $null as a value for parameter PodExecutionRoleArn 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.Selector != null) { context.Selector = new List(this.Selector); } if (this.Subnet != null) { context.Subnet = new List(this.Subnet); } 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.CreateFargateProfileRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.ClusterName != null) { request.ClusterName = cmdletContext.ClusterName; } if (cmdletContext.FargateProfileName != null) { request.FargateProfileName = cmdletContext.FargateProfileName; } if (cmdletContext.PodExecutionRoleArn != null) { request.PodExecutionRoleArn = cmdletContext.PodExecutionRoleArn; } if (cmdletContext.Selector != null) { request.Selectors = cmdletContext.Selector; } if (cmdletContext.Subnet != null) { request.Subnets = cmdletContext.Subnet; } 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.CreateFargateProfileResponse CallAWSServiceOperation(IAmazonEKS client, Amazon.EKS.Model.CreateFargateProfileRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Container Service for Kubernetes", "CreateFargateProfile"); try { #if DESKTOP return client.CreateFargateProfile(request); #elif CORECLR return client.CreateFargateProfileAsync(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 System.String ClusterName { get; set; } public System.String FargateProfileName { get; set; } public System.String PodExecutionRoleArn { get; set; } public List Selector { get; set; } public List Subnet { get; set; } public Dictionary Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FargateProfile; } } }