/******************************************************************************* * 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.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Deletes the specified grant. You revoke a grant to terminate the permissions that /// the grant allows. For more information, see Retiring /// and revoking grants in the Key Management Service Developer Guide. /// /// /// /// When you create, retire, or revoke a grant, there might be a brief delay, usually /// less than five minutes, until the grant is available throughout KMS. This state is /// known as eventual consistency. For details, see Eventual /// consistency in the Key Management Service Developer Guide. /// /// For detailed information about grants, including grant terminology, see Grants /// in KMS in the Key Management Service Developer Guide. For examples /// of working with grants in several programming languages, see Programming /// grants. /// Cross-account use: Yes. To perform this operation on a KMS key in a different /// Amazon Web Services account, specify the key ARN in the value of the KeyId /// parameter. /// Required permissions: kms:RevokeGrant /// (key policy). /// Related operations: /// [Cmdlet("Revoke", "KMSGrant", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Key Management Service RevokeGrant API operation.", Operation = new[] {"RevokeGrant"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.RevokeGrantResponse))] [AWSCmdletOutput("None or Amazon.KeyManagementService.Model.RevokeGrantResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.KeyManagementService.Model.RevokeGrantResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RevokeKMSGrantCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter DryRun /// /// /// Checks if your request will succeed. DryRun is an optional parameter. /// To learn more about how to use this parameter, see Testing /// your KMS API calls in the Key Management Service Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DryRun { get; set; } #endregion #region Parameter GrantId /// /// /// Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, /// or ListRetirableGrants. /// /// #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 GrantId { get; set; } #endregion #region Parameter KeyId /// /// /// A unique identifier for the KMS key associated with the grant. To get the key ID and /// key ARN for a KMS key, use ListKeys or DescribeKey.Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different /// Amazon Web Services account, you must use the key ARN.For example:To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. /// /// #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 KeyId { 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.KeyManagementService.Model.RevokeGrantResponse). /// 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 KeyId parameter. /// The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyId' 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.KeyId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Revoke-KMSGrant (RevokeGrant)")) { 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.KeyId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DryRun = this.DryRun; context.GrantId = this.GrantId; #if MODULAR if (this.GrantId == null && ParameterWasBound(nameof(this.GrantId))) { WriteWarning("You are passing $null as a value for parameter GrantId 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.KeyId = this.KeyId; #if MODULAR if (this.KeyId == null && ParameterWasBound(nameof(this.KeyId))) { WriteWarning("You are passing $null as a value for parameter KeyId 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 // 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.KeyManagementService.Model.RevokeGrantRequest(); if (cmdletContext.DryRun != null) { request.DryRun = cmdletContext.DryRun.Value; } if (cmdletContext.GrantId != null) { request.GrantId = cmdletContext.GrantId; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } 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.KeyManagementService.Model.RevokeGrantResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.RevokeGrantRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "RevokeGrant"); try { #if DESKTOP return client.RevokeGrant(request); #elif CORECLR return client.RevokeGrantAsync(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.Boolean? DryRun { get; set; } public System.String GrantId { get; set; } public System.String KeyId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }