/******************************************************************************* * 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.CloudWatchEvents; using Amazon.CloudWatchEvents.Model; namespace Amazon.PowerShell.Cmdlets.CWE { /// /// Running PutPermission permits the specified Amazon Web Services account /// or Amazon Web Services organization to put events to the specified event bus. /// Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these /// events arriving to an event bus in your account. /// /// /// /// For another account to send events to your account, that external account must have /// an EventBridge rule with your account's event bus as a target. /// /// To enable multiple Amazon Web Services accounts to put events to your event bus, run /// PutPermission once for each of these accounts. Or, if all the accounts /// are members of the same Amazon Web Services organization, you can run PutPermission /// once specifying Principal as "*" and specifying the Amazon Web Services /// organization ID in Condition, to grant permissions to all accounts in /// that organization. /// /// If you grant permissions using an organization, then accounts in that organization /// must specify a RoleArn with proper permissions when they use PutTarget /// to add your account's event bus as a target. For more information, see Sending /// and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge /// User Guide. /// /// The permission policy on the event bus cannot exceed 10 KB in size. /// /// [Cmdlet("Write", "CWEPermission", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon CloudWatch Events PutPermission API operation.", Operation = new[] {"PutPermission"}, SelectReturnType = typeof(Amazon.CloudWatchEvents.Model.PutPermissionResponse))] [AWSCmdletOutput("None or Amazon.CloudWatchEvents.Model.PutPermissionResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.CloudWatchEvents.Model.PutPermissionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteCWEPermissionCmdlet : AmazonCloudWatchEventsClientCmdlet, IExecutor { #region Parameter Action /// /// /// The action that you are enabling the other account to perform. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Action { get; set; } #endregion #region Parameter EventBusName /// /// /// The name of the event bus associated with the rule. If you omit this, the default /// event bus is used. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EventBusName { get; set; } #endregion #region Parameter Condition_Key /// /// /// Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Condition_Key { get; set; } #endregion #region Parameter Policy /// /// /// A JSON string that describes the permission policy statement. You can include a Policy /// parameter in the request instead of using the StatementId, Action, /// Principal, or Condition parameters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Policy { get; set; } #endregion #region Parameter Principal /// /// /// The 12-digit Amazon Web Services account ID that you are permitting to put events /// to your default event bus. Specify "*" to permit any account to put events to your /// default event bus.If you specify "*" without specifying Condition, avoid creating rules /// that may match undesirable events. To create more secure rules, make sure that the /// event pattern for each rule contains an account field with a specific /// account ID from which to receive events. Rules with an account field do not match /// any events sent from other accounts. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Principal { get; set; } #endregion #region Parameter StatementId /// /// /// An identifier string for the external account that you are granting permissions to. /// If you later want to revoke the permission for this external account, specify this /// StatementId when you run RemovePermission. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String StatementId { get; set; } #endregion #region Parameter Condition_Type /// /// /// Specifies the type of condition. Currently the only supported value is StringEquals. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Condition_Type { get; set; } #endregion #region Parameter Condition_Value /// /// /// Specifies the value for the key. Currently, this must be the ID of the organization. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Condition_Value { 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.CloudWatchEvents.Model.PutPermissionResponse). /// 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 StatementId parameter. /// The -PassThru parameter is deprecated, use -Select '^StatementId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StatementId' 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.StatementId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CWEPermission (PutPermission)")) { 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.StatementId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Action = this.Action; context.Condition_Key = this.Condition_Key; context.Condition_Type = this.Condition_Type; context.Condition_Value = this.Condition_Value; context.EventBusName = this.EventBusName; context.Policy = this.Policy; context.Principal = this.Principal; context.StatementId = this.StatementId; // 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.CloudWatchEvents.Model.PutPermissionRequest(); if (cmdletContext.Action != null) { request.Action = cmdletContext.Action; } // populate Condition var requestConditionIsNull = true; request.Condition = new Amazon.CloudWatchEvents.Model.Condition(); System.String requestCondition_condition_Key = null; if (cmdletContext.Condition_Key != null) { requestCondition_condition_Key = cmdletContext.Condition_Key; } if (requestCondition_condition_Key != null) { request.Condition.Key = requestCondition_condition_Key; requestConditionIsNull = false; } System.String requestCondition_condition_Type = null; if (cmdletContext.Condition_Type != null) { requestCondition_condition_Type = cmdletContext.Condition_Type; } if (requestCondition_condition_Type != null) { request.Condition.Type = requestCondition_condition_Type; requestConditionIsNull = false; } System.String requestCondition_condition_Value = null; if (cmdletContext.Condition_Value != null) { requestCondition_condition_Value = cmdletContext.Condition_Value; } if (requestCondition_condition_Value != null) { request.Condition.Value = requestCondition_condition_Value; requestConditionIsNull = false; } // determine if request.Condition should be set to null if (requestConditionIsNull) { request.Condition = null; } if (cmdletContext.EventBusName != null) { request.EventBusName = cmdletContext.EventBusName; } if (cmdletContext.Policy != null) { request.Policy = cmdletContext.Policy; } if (cmdletContext.Principal != null) { request.Principal = cmdletContext.Principal; } if (cmdletContext.StatementId != null) { request.StatementId = cmdletContext.StatementId; } 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.CloudWatchEvents.Model.PutPermissionResponse CallAWSServiceOperation(IAmazonCloudWatchEvents client, Amazon.CloudWatchEvents.Model.PutPermissionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch Events", "PutPermission"); try { #if DESKTOP return client.PutPermission(request); #elif CORECLR return client.PutPermissionAsync(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 Action { get; set; } public System.String Condition_Key { get; set; } public System.String Condition_Type { get; set; } public System.String Condition_Value { get; set; } public System.String EventBusName { get; set; } public System.String Policy { get; set; } public System.String Principal { get; set; } public System.String StatementId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }