/******************************************************************************* * 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 { /// /// Adds the specified targets to the specified rule, or updates the targets if they are /// already associated with the rule. /// /// /// /// Targets are the resources that are invoked when a rule is triggered. /// /// You can configure the following as targets for Events: /// /// Creating rules with built-in targets is supported only in the Management Console. /// The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances /// API call, EC2 StopInstances API call, and EC2 TerminateInstances /// API call. /// /// For some target types, PutTargets provides target-specific parameters. /// If the target is a Kinesis data stream, you can optionally specify which shard the /// event goes to by using the KinesisParameters argument. To invoke a command /// on multiple EC2 instances with one rule, you can use the RunCommandParameters /// field. /// /// To be able to make API calls against the resources that you own, Amazon EventBridge /// needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge /// relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions /// state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you /// specify in the RoleARN argument in PutTargets. For more /// information, see Authentication /// and Access Control in the Amazon EventBridge User Guide. /// /// If another Amazon Web Services account is in the same region and has granted you permission /// (using PutPermission), you can send events to that account. Set that /// account's event bus as a target of the rules in your account. To send the matched /// events to the other account, specify that account's event bus as the Arn /// value when you run PutTargets. If your account sends events to another /// account, your account is charged for each sent event. Each event sent to another account /// is charged as a custom event. The account receiving the event is not charged. For /// more information, see Amazon /// EventBridge Pricing. /// Input, InputPath, and InputTransformer are /// not available with PutTarget if the target is an event bus of a different /// Amazon Web Services account. /// /// If you are setting the event bus of another account as the target, and that account /// granted permission to your account through an organization instead of directly by /// the account ID, then you must specify a RoleArn with proper permissions /// in the Target structure. For more information, see Sending /// and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge /// User Guide. /// /// For more information about enabling cross-account events, see PutPermission. /// Input, InputPath, and InputTransformer are mutually exclusive /// and optional parameters of a target. When a rule is triggered due to a matched event: /// /// When you specify InputPath or InputTransformer, you must /// use JSON dot notation, not bracket notation. /// /// When you add targets to a rule and the associated rule triggers soon after, new or /// updated targets might not be immediately invoked. Allow a short period of time for /// changes to take effect. /// /// This action can partially fail if too many requests are made at the same time. If /// that happens, FailedEntryCount is non-zero in the response and each entry /// in FailedEntries provides the ID of the failed target and the error code. /// /// [Cmdlet("Write", "CWETarget", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.CloudWatchEvents.Model.PutTargetsResultEntry")] [AWSCmdlet("Calls the Amazon CloudWatch Events PutTargets API operation.", Operation = new[] {"PutTargets"}, SelectReturnType = typeof(Amazon.CloudWatchEvents.Model.PutTargetsResponse))] [AWSCmdletOutput("Amazon.CloudWatchEvents.Model.PutTargetsResultEntry or Amazon.CloudWatchEvents.Model.PutTargetsResponse", "This cmdlet returns a collection of Amazon.CloudWatchEvents.Model.PutTargetsResultEntry objects.", "The service call response (type Amazon.CloudWatchEvents.Model.PutTargetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class WriteCWETargetCmdlet : AmazonCloudWatchEventsClientCmdlet, IExecutor { #region Parameter EventBusName /// /// /// The name or ARN 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 Rule /// /// /// The name of the rule. /// /// #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 Rule { get; set; } #endregion #region Parameter Target /// /// /// The targets to update or add to the rule. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("Targets")] public Amazon.CloudWatchEvents.Model.Target[] Target { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'FailedEntries'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchEvents.Model.PutTargetsResponse). /// Specifying the name of a property of type Amazon.CloudWatchEvents.Model.PutTargetsResponse 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; } = "FailedEntries"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Rule parameter. /// The -PassThru parameter is deprecated, use -Select '^Rule' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Rule' 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.Rule), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CWETarget (PutTargets)")) { 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.Rule; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.EventBusName = this.EventBusName; context.Rule = this.Rule; #if MODULAR if (this.Rule == null && ParameterWasBound(nameof(this.Rule))) { WriteWarning("You are passing $null as a value for parameter Rule 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.Target != null) { context.Target = new List(this.Target); } #if MODULAR if (this.Target == null && ParameterWasBound(nameof(this.Target))) { WriteWarning("You are passing $null as a value for parameter Target 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.CloudWatchEvents.Model.PutTargetsRequest(); if (cmdletContext.EventBusName != null) { request.EventBusName = cmdletContext.EventBusName; } if (cmdletContext.Rule != null) { request.Rule = cmdletContext.Rule; } if (cmdletContext.Target != null) { request.Targets = cmdletContext.Target; } 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.PutTargetsResponse CallAWSServiceOperation(IAmazonCloudWatchEvents client, Amazon.CloudWatchEvents.Model.PutTargetsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudWatch Events", "PutTargets"); try { #if DESKTOP return client.PutTargets(request); #elif CORECLR return client.PutTargetsAsync(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 EventBusName { get; set; } public System.String Rule { get; set; } public List Target { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FailedEntries; } } }