/*******************************************************************************
* 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.ServiceCatalog;
using Amazon.ServiceCatalog.Model;
namespace Amazon.PowerShell.Cmdlets.SC
{
///
/// Disassociates a previously associated principal ARN from a specified portfolio.
///
///
///
/// The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio
/// call request details. For example, to disassociate an association created with a PrincipalARN
/// of PrincipalType IAM you must use the PrincipalType IAM
/// when calling DisassociatePrincipalFromPortfolio.
///
/// For portfolios that have been shared with principal name sharing enabled: after disassociating
/// a principal, share recipient accounts will no longer be able to provision products
/// in this portfolio using a role matching the name of the associated principal.
///
/// For more information, review associate-principal-with-portfolio
/// in the Amazon Web Services CLI Command Reference.
///
/// If you disassociate a principal from a portfolio, with PrincipalType as IAM,
/// the same principal will still have access to the portfolio if it matches one of the
/// associated principals of type IAM_PATTERN. To fully remove access for
/// a principal, verify all the associated Principals of type IAM_PATTERN,
/// and then ensure you disassociate any IAM_PATTERN principals that match
/// the principal whose access you are removing.
///
///
[Cmdlet("Unregister", "SCPrincipalFromPortfolio", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the AWS Service Catalog DisassociatePrincipalFromPortfolio API operation.", Operation = new[] {"DisassociatePrincipalFromPortfolio"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse))]
[AWSCmdletOutput("None or Amazon.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UnregisterSCPrincipalFromPortfolioCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor
{
#region Parameter AcceptLanguage
///
///
/// The language code.jp - Japanesezh - Chinese
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AcceptLanguage { get; set; }
#endregion
#region Parameter PortfolioId
///
///
/// The portfolio identifier.
///
///
#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 PortfolioId { get; set; }
#endregion
#region Parameter PrincipalARN
///
///
/// The ARN of the principal (user, role, or group). This field allows an ARN with no
/// accountID with or without wildcard characters if PrincipalType
/// is IAM_PATTERN.
///
///
#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 PrincipalARN { get; set; }
#endregion
#region Parameter PrincipalType
///
///
/// The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN
/// if you specify an IAM ARN with no AccountId, with or without wildcard
/// characters.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.ServiceCatalog.PrincipalType")]
public Amazon.ServiceCatalog.PrincipalType PrincipalType { 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.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse).
/// 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 PrincipalARN parameter.
/// The -PassThru parameter is deprecated, use -Select '^PrincipalARN' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PrincipalARN' 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.PortfolioId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Unregister-SCPrincipalFromPortfolio (DisassociatePrincipalFromPortfolio)"))
{
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.PrincipalARN;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AcceptLanguage = this.AcceptLanguage;
context.PortfolioId = this.PortfolioId;
#if MODULAR
if (this.PortfolioId == null && ParameterWasBound(nameof(this.PortfolioId)))
{
WriteWarning("You are passing $null as a value for parameter PortfolioId 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.PrincipalARN = this.PrincipalARN;
#if MODULAR
if (this.PrincipalARN == null && ParameterWasBound(nameof(this.PrincipalARN)))
{
WriteWarning("You are passing $null as a value for parameter PrincipalARN 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.PrincipalType = this.PrincipalType;
// 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.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioRequest();
if (cmdletContext.AcceptLanguage != null)
{
request.AcceptLanguage = cmdletContext.AcceptLanguage;
}
if (cmdletContext.PortfolioId != null)
{
request.PortfolioId = cmdletContext.PortfolioId;
}
if (cmdletContext.PrincipalARN != null)
{
request.PrincipalARN = cmdletContext.PrincipalARN;
}
if (cmdletContext.PrincipalType != null)
{
request.PrincipalType = cmdletContext.PrincipalType;
}
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.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "DisassociatePrincipalFromPortfolio");
try
{
#if DESKTOP
return client.DisassociatePrincipalFromPortfolio(request);
#elif CORECLR
return client.DisassociatePrincipalFromPortfolioAsync(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 AcceptLanguage { get; set; }
public System.String PortfolioId { get; set; }
public System.String PrincipalARN { get; set; }
public Amazon.ServiceCatalog.PrincipalType PrincipalType { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}