/*******************************************************************************
* 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.GuardDuty;
using Amazon.GuardDuty.Model;
namespace Amazon.PowerShell.Cmdlets.GD
{
///
/// Invites Amazon Web Services accounts to become members of an organization administered
/// by the Amazon Web Services account that invokes this API. If you are using Amazon
/// Web Services Organizations to manager your GuardDuty environment, this step is not
/// needed. For more information, see Managing
/// accounts with Amazon Web Services Organizations.
///
///
///
/// To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty
/// has been enabled in the potential member accounts. You can now invoke this API to
/// add accounts by invitation. The invited accounts can either accept or decline the
/// invitation from their GuardDuty accounts. Each invited Amazon Web Services account
/// can choose to accept the invitation from only one Amazon Web Services account. For
/// more information, see Managing
/// GuardDuty accounts by invitation.
///
/// After the invite has been accepted and you choose to disassociate a member account
/// (by using DisassociateMembers)
/// from your account, the details of the member account obtained by invoking CreateMembers,
/// including the associated email addresses, will be retained. This is done so that you
/// can invoke InviteMembers without the need to invoke CreateMembers
/// again. To remove the details associated with a member account, you must also invoke
/// DeleteMembers.
///
///
///
[Cmdlet("Send", "GDMemberInvitation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.GuardDuty.Model.UnprocessedAccount")]
[AWSCmdlet("Calls the Amazon GuardDuty InviteMembers API operation.", Operation = new[] {"InviteMembers"}, SelectReturnType = typeof(Amazon.GuardDuty.Model.InviteMembersResponse))]
[AWSCmdletOutput("Amazon.GuardDuty.Model.UnprocessedAccount or Amazon.GuardDuty.Model.InviteMembersResponse",
"This cmdlet returns a collection of Amazon.GuardDuty.Model.UnprocessedAccount objects.",
"The service call response (type Amazon.GuardDuty.Model.InviteMembersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SendGDMemberInvitationCmdlet : AmazonGuardDutyClientCmdlet, IExecutor
{
#region Parameter AccountId
///
///
/// A list of account IDs of the accounts that you want to invite to GuardDuty as members.
///
///
#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.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("AccountIds")]
public System.String[] AccountId { get; set; }
#endregion
#region Parameter DetectorId
///
///
/// The unique ID of the detector of the GuardDuty account that you want to invite members
/// with.
///
///
#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 DetectorId { get; set; }
#endregion
#region Parameter DisableEmailNotification
///
///
/// A Boolean value that specifies whether you want to disable email notification to the
/// accounts that you are inviting to GuardDuty as members.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DisableEmailNotification { get; set; }
#endregion
#region Parameter Message
///
///
/// The invitation message that you want to send to the accounts that you're inviting
/// to GuardDuty as members.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Message { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'UnprocessedAccounts'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GuardDuty.Model.InviteMembersResponse).
/// Specifying the name of a property of type Amazon.GuardDuty.Model.InviteMembersResponse 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; } = "UnprocessedAccounts";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AccountId parameter.
/// The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AccountId' 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.DetectorId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Send-GDMemberInvitation (InviteMembers)"))
{
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.AccountId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AccountId != null)
{
context.AccountId = new List(this.AccountId);
}
#if MODULAR
if (this.AccountId == null && ParameterWasBound(nameof(this.AccountId)))
{
WriteWarning("You are passing $null as a value for parameter AccountId 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.DetectorId = this.DetectorId;
#if MODULAR
if (this.DetectorId == null && ParameterWasBound(nameof(this.DetectorId)))
{
WriteWarning("You are passing $null as a value for parameter DetectorId 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.DisableEmailNotification = this.DisableEmailNotification;
context.Message = this.Message;
// 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.GuardDuty.Model.InviteMembersRequest();
if (cmdletContext.AccountId != null)
{
request.AccountIds = cmdletContext.AccountId;
}
if (cmdletContext.DetectorId != null)
{
request.DetectorId = cmdletContext.DetectorId;
}
if (cmdletContext.DisableEmailNotification != null)
{
request.DisableEmailNotification = cmdletContext.DisableEmailNotification.Value;
}
if (cmdletContext.Message != null)
{
request.Message = cmdletContext.Message;
}
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.GuardDuty.Model.InviteMembersResponse CallAWSServiceOperation(IAmazonGuardDuty client, Amazon.GuardDuty.Model.InviteMembersRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GuardDuty", "InviteMembers");
try
{
#if DESKTOP
return client.InviteMembers(request);
#elif CORECLR
return client.InviteMembersAsync(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 AccountId { get; set; }
public System.String DetectorId { get; set; }
public System.Boolean? DisableEmailNotification { get; set; }
public System.String Message { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.UnprocessedAccounts;
}
}
}