/******************************************************************************* * 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.SimpleSystemsManagement; using Amazon.SimpleSystemsManagement.Model; namespace Amazon.PowerShell.Cmdlets.SSM { /// /// Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. /// If you share a document privately, you must specify the Amazon Web Services user IDs /// for those people who can use the document. If you share a document publicly, you must /// specify All as the account ID. /// [Cmdlet("Edit", "SSMDocumentPermission", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS Systems Manager ModifyDocumentPermission API operation.", Operation = new[] {"ModifyDocumentPermission"}, SelectReturnType = typeof(Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse))] [AWSCmdletOutput("None or Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EditSSMDocumentPermissionCmdlet : AmazonSimpleSystemsManagementClientCmdlet, IExecutor { #region Parameter AccountIdsToAdd /// /// /// The Amazon Web Services users that should have access to the document. The account /// IDs can either be a group of account IDs or All. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] AccountIdsToAdd { get; set; } #endregion #region Parameter AccountIdsToRemove /// /// /// The Amazon Web Services users that should no longer have access to the document. The /// Amazon Web Services user can either be a group of account IDs or All. This /// action has a higher priority than AccountIdsToAdd. If you specify an ID to /// add and the same ID to remove, the system removes access to the document. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] AccountIdsToRemove { get; set; } #endregion #region Parameter Name /// /// /// The name of the document that you want to share. /// /// #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 PermissionType /// /// /// The permission type for the document. The permission type can be Share. /// /// #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.SimpleSystemsManagement.DocumentPermissionType")] public Amazon.SimpleSystemsManagement.DocumentPermissionType PermissionType { get; set; } #endregion #region Parameter SharedDocumentVersion /// /// /// (Optional) The version of the document to share. If it isn't specified, the system /// choose the Default version to share. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SharedDocumentVersion { 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.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse). /// 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, "Edit-SSMDocumentPermission (ModifyDocumentPermission)")) { 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.AccountIdsToAdd != null) { context.AccountIdsToAdd = new List(this.AccountIdsToAdd); } if (this.AccountIdsToRemove != null) { context.AccountIdsToRemove = new List(this.AccountIdsToRemove); } 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.PermissionType = this.PermissionType; #if MODULAR if (this.PermissionType == null && ParameterWasBound(nameof(this.PermissionType))) { WriteWarning("You are passing $null as a value for parameter PermissionType 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.SharedDocumentVersion = this.SharedDocumentVersion; // 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.SimpleSystemsManagement.Model.ModifyDocumentPermissionRequest(); if (cmdletContext.AccountIdsToAdd != null) { request.AccountIdsToAdd = cmdletContext.AccountIdsToAdd; } if (cmdletContext.AccountIdsToRemove != null) { request.AccountIdsToRemove = cmdletContext.AccountIdsToRemove; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.PermissionType != null) { request.PermissionType = cmdletContext.PermissionType; } if (cmdletContext.SharedDocumentVersion != null) { request.SharedDocumentVersion = cmdletContext.SharedDocumentVersion; } 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.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse CallAWSServiceOperation(IAmazonSimpleSystemsManagement client, Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Systems Manager", "ModifyDocumentPermission"); try { #if DESKTOP return client.ModifyDocumentPermission(request); #elif CORECLR return client.ModifyDocumentPermissionAsync(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 AccountIdsToAdd { get; set; } public List AccountIdsToRemove { get; set; } public System.String Name { get; set; } public Amazon.SimpleSystemsManagement.DocumentPermissionType PermissionType { get; set; } public System.String SharedDocumentVersion { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }