/******************************************************************************* * 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.EC2; using Amazon.EC2.Model; namespace Amazon.PowerShell.Cmdlets.EC2 { /// /// Describes the ID format settings for resources for the specified IAM user, IAM role, /// or root user. For example, you can view the resource types that are enabled for longer /// IDs. This request only returns information about resource types whose ID formats can /// be modified; it does not return information about other resource types. For more information, /// see Resource /// IDs in the Amazon Elastic Compute Cloud User Guide. /// /// /// /// The following resource types support longer IDs: bundle | conversion-task /// | customer-gateway | dhcp-options | elastic-ip-allocation /// | elastic-ip-association | export-task | flow-log /// | image | import-task | instance | internet-gateway /// | network-acl | network-acl-association | network-interface /// | network-interface-attachment | prefix-list | reservation /// | route-table | route-table-association | security-group /// | snapshot | subnet | subnet-cidr-block-association /// | volume | vpc | vpc-cidr-block-association /// | vpc-endpoint | vpc-peering-connection | vpn-connection /// | vpn-gateway. /// /// These settings apply to the principal specified in the request. They do not apply /// to the principal that makes the request. /// /// [Cmdlet("Get", "EC2IdentityIdFormat")] [OutputType("Amazon.EC2.Model.IdFormat")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) DescribeIdentityIdFormat API operation.", Operation = new[] {"DescribeIdentityIdFormat"}, SelectReturnType = typeof(Amazon.EC2.Model.DescribeIdentityIdFormatResponse))] [AWSCmdletOutput("Amazon.EC2.Model.IdFormat or Amazon.EC2.Model.DescribeIdentityIdFormatResponse", "This cmdlet returns a collection of Amazon.EC2.Model.IdFormat objects.", "The service call response (type Amazon.EC2.Model.DescribeIdentityIdFormatResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEC2IdentityIdFormatCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter PrincipalArn /// /// /// The ARN of the principal, which can be an IAM role, IAM user, or the root user. /// /// #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 PrincipalArn { get; set; } #endregion #region Parameter Resource /// /// /// The type of resource: bundle | conversion-task | customer-gateway /// | dhcp-options | elastic-ip-allocation | elastic-ip-association /// | export-task | flow-log | image | import-task /// | instance | internet-gateway | network-acl /// | network-acl-association | network-interface | network-interface-attachment /// | prefix-list | reservation | route-table | /// route-table-association | security-group | snapshot /// | subnet | subnet-cidr-block-association | volume /// | vpc | vpc-cidr-block-association | vpc-endpoint /// | vpc-peering-connection | vpn-connection | vpn-gateway /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String Resource { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Statuses'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeIdentityIdFormatResponse). /// Specifying the name of a property of type Amazon.EC2.Model.DescribeIdentityIdFormatResponse 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; } = "Statuses"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the PrincipalArn parameter. /// The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PrincipalArn' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.PrincipalArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.PrincipalArn = this.PrincipalArn; #if MODULAR if (this.PrincipalArn == null && ParameterWasBound(nameof(this.PrincipalArn))) { WriteWarning("You are passing $null as a value for parameter PrincipalArn 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.Resource = this.Resource; // 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.EC2.Model.DescribeIdentityIdFormatRequest(); if (cmdletContext.PrincipalArn != null) { request.PrincipalArn = cmdletContext.PrincipalArn; } if (cmdletContext.Resource != null) { request.Resource = cmdletContext.Resource; } 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.EC2.Model.DescribeIdentityIdFormatResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.DescribeIdentityIdFormatRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "DescribeIdentityIdFormat"); try { #if DESKTOP return client.DescribeIdentityIdFormat(request); #elif CORECLR return client.DescribeIdentityIdFormatAsync(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 PrincipalArn { get; set; } public System.String Resource { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Statuses; } } }