/*******************************************************************************
* 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.WorkSpacesWeb;
using Amazon.WorkSpacesWeb.Model;
namespace Amazon.PowerShell.Cmdlets.WSW
{
///
/// Creates an identity provider resource that is then associated with a web portal.
///
[Cmdlet("New", "WSWIdentityProvider", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon WorkSpaces Web CreateIdentityProvider API operation.", Operation = new[] {"CreateIdentityProvider"}, SelectReturnType = typeof(Amazon.WorkSpacesWeb.Model.CreateIdentityProviderResponse))]
[AWSCmdletOutput("System.String or Amazon.WorkSpacesWeb.Model.CreateIdentityProviderResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.WorkSpacesWeb.Model.CreateIdentityProviderResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewWSWIdentityProviderCmdlet : AmazonWorkSpacesWebClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter IdentityProviderDetail
///
///
/// The identity provider details. The following list describes the provider detail keys
/// for each identity provider type. - For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
- For Facebook:
client_id
client_secret
authorize_scopes
api_version
- For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
- For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url
if not available from discovery URL specified by oidc_issuer
/// keytoken_url
if not available from discovery URL specified by oidc_issuer
/// keyattributes_url
if not available from discovery URL specified by oidc_issuer
/// keyjwks_uri
if not available from discovery URL specified by oidc_issuer
/// key
- For SAML providers:
MetadataFile
OR MetadataURL
IDPSignout
(boolean) optional
///
///
#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("IdentityProviderDetails")]
public System.Collections.Hashtable IdentityProviderDetail { get; set; }
#endregion
#region Parameter IdentityProviderName
///
///
/// The identity provider name.
///
///
#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 IdentityProviderName { get; set; }
#endregion
#region Parameter IdentityProviderType
///
///
/// The identity provider type.
///
///
#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.WorkSpacesWeb.IdentityProviderType")]
public Amazon.WorkSpacesWeb.IdentityProviderType IdentityProviderType { get; set; }
#endregion
#region Parameter PortalArn
///
///
/// The ARN of the web portal.
///
///
#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 PortalArn { get; set; }
#endregion
#region Parameter ClientToken
///
///
/// A unique, case-sensitive identifier that you provide to ensure the idempotency of
/// the request. Idempotency ensures that an API request completes only once. With an
/// idempotent request, if the original request completes successfully, subsequent retries
/// with the same client token returns the result from the original successful request.If you do not specify a client token, one is automatically generated by the AWS SDK.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'IdentityProviderArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkSpacesWeb.Model.CreateIdentityProviderResponse).
/// Specifying the name of a property of type Amazon.WorkSpacesWeb.Model.CreateIdentityProviderResponse 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; } = "IdentityProviderArn";
#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.PortalArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-WSWIdentityProvider (CreateIdentityProvider)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.ClientToken = this.ClientToken;
if (this.IdentityProviderDetail != null)
{
context.IdentityProviderDetail = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.IdentityProviderDetail.Keys)
{
context.IdentityProviderDetail.Add((String)hashKey, (String)(this.IdentityProviderDetail[hashKey]));
}
}
#if MODULAR
if (this.IdentityProviderDetail == null && ParameterWasBound(nameof(this.IdentityProviderDetail)))
{
WriteWarning("You are passing $null as a value for parameter IdentityProviderDetail 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.IdentityProviderName = this.IdentityProviderName;
#if MODULAR
if (this.IdentityProviderName == null && ParameterWasBound(nameof(this.IdentityProviderName)))
{
WriteWarning("You are passing $null as a value for parameter IdentityProviderName 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.IdentityProviderType = this.IdentityProviderType;
#if MODULAR
if (this.IdentityProviderType == null && ParameterWasBound(nameof(this.IdentityProviderType)))
{
WriteWarning("You are passing $null as a value for parameter IdentityProviderType 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.PortalArn = this.PortalArn;
#if MODULAR
if (this.PortalArn == null && ParameterWasBound(nameof(this.PortalArn)))
{
WriteWarning("You are passing $null as a value for parameter PortalArn 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.WorkSpacesWeb.Model.CreateIdentityProviderRequest();
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.IdentityProviderDetail != null)
{
request.IdentityProviderDetails = cmdletContext.IdentityProviderDetail;
}
if (cmdletContext.IdentityProviderName != null)
{
request.IdentityProviderName = cmdletContext.IdentityProviderName;
}
if (cmdletContext.IdentityProviderType != null)
{
request.IdentityProviderType = cmdletContext.IdentityProviderType;
}
if (cmdletContext.PortalArn != null)
{
request.PortalArn = cmdletContext.PortalArn;
}
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.WorkSpacesWeb.Model.CreateIdentityProviderResponse CallAWSServiceOperation(IAmazonWorkSpacesWeb client, Amazon.WorkSpacesWeb.Model.CreateIdentityProviderRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces Web", "CreateIdentityProvider");
try
{
#if DESKTOP
return client.CreateIdentityProvider(request);
#elif CORECLR
return client.CreateIdentityProviderAsync(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 ClientToken { get; set; }
public Dictionary IdentityProviderDetail { get; set; }
public System.String IdentityProviderName { get; set; }
public Amazon.WorkSpacesWeb.IdentityProviderType IdentityProviderType { get; set; }
public System.String PortalArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.IdentityProviderArn;
}
}
}