/*******************************************************************************
* 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.Finspace;
using Amazon.Finspace.Model;
namespace Amazon.PowerShell.Cmdlets.FINSP
{
///
/// Create a new FinSpace environment.
///
[Cmdlet("New", "FINSPEnvironment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Finspace.Model.CreateEnvironmentResponse")]
[AWSCmdlet("Calls the FinSpace User Environment Management Service CreateEnvironment API operation.", Operation = new[] {"CreateEnvironment"}, SelectReturnType = typeof(Amazon.Finspace.Model.CreateEnvironmentResponse))]
[AWSCmdletOutput("Amazon.Finspace.Model.CreateEnvironmentResponse",
"This cmdlet returns an Amazon.Finspace.Model.CreateEnvironmentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewFINSPEnvironmentCmdlet : AmazonFinspaceClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter FederationParameters_ApplicationCallBackURL
///
///
/// The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity
/// provider configuration (IdP).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FederationParameters_ApplicationCallBackURL { get; set; }
#endregion
#region Parameter FederationParameters_AttributeMap
///
///
/// SAML attribute name and value. The name must always be Email
and the
/// value should be set to the attribute definition in which user email is set. For example,
/// name would be Email
and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
.
/// Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable FederationParameters_AttributeMap { get; set; }
#endregion
#region Parameter DataBundle
///
///
/// The list of Amazon Resource Names (ARN) of the data bundles to install. Currently
/// supported data bundle ARNs:arn:aws:finspace:${Region}::data-bundle/capital-markets-sample
- Contains
/// sample Capital Markets datasets, categories and controlled vocabularies.arn:aws:finspace:${Region}::data-bundle/taq
(default) - Contains trades
/// and quotes data in addition to sample Capital Markets data.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DataBundles")]
public System.String[] DataBundle { get; set; }
#endregion
#region Parameter Description
///
///
/// The description of the FinSpace environment to be created.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter SuperuserParameters_EmailAddress
///
///
/// The email address of the superuser.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SuperuserParameters_EmailAddress { get; set; }
#endregion
#region Parameter FederationMode
///
///
/// Authentication mode for the environment.FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your
/// Identity provider.LOCAL
- Users access FinSpace via email and password managed within
/// the FinSpace environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Finspace.FederationMode")]
public Amazon.Finspace.FederationMode FederationMode { get; set; }
#endregion
#region Parameter FederationParameters_FederationProviderName
///
///
/// Name of the identity provider (IdP).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FederationParameters_FederationProviderName { get; set; }
#endregion
#region Parameter FederationParameters_FederationURN
///
///
/// The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience
/// URI or Service Provider Entity ID.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FederationParameters_FederationURN { get; set; }
#endregion
#region Parameter SuperuserParameters_FirstName
///
///
/// The first name of the superuser.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SuperuserParameters_FirstName { get; set; }
#endregion
#region Parameter KmsKeyId
///
///
/// The KMS key id to encrypt your data in the FinSpace environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyId { get; set; }
#endregion
#region Parameter SuperuserParameters_LastName
///
///
/// The last name of the superuser.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SuperuserParameters_LastName { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the FinSpace environment to be created.
///
///
#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 Name { get; set; }
#endregion
#region Parameter FederationParameters_SamlMetadataDocument
///
///
/// SAML 2.0 Metadata document from identity provider (IdP).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FederationParameters_SamlMetadataDocument { get; set; }
#endregion
#region Parameter FederationParameters_SamlMetadataURL
///
///
/// Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FederationParameters_SamlMetadataURL { get; set; }
#endregion
#region Parameter Tag
///
///
/// Add tags to your FinSpace environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.CreateEnvironmentResponse).
/// Specifying the name of a property of type Amazon.Finspace.Model.CreateEnvironmentResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Name parameter.
/// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-FINSPEnvironment (CreateEnvironment)"))
{
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.Name;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.DataBundle != null)
{
context.DataBundle = new List(this.DataBundle);
}
context.Description = this.Description;
context.FederationMode = this.FederationMode;
context.FederationParameters_ApplicationCallBackURL = this.FederationParameters_ApplicationCallBackURL;
if (this.FederationParameters_AttributeMap != null)
{
context.FederationParameters_AttributeMap = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.FederationParameters_AttributeMap.Keys)
{
context.FederationParameters_AttributeMap.Add((String)hashKey, (String)(this.FederationParameters_AttributeMap[hashKey]));
}
}
context.FederationParameters_FederationProviderName = this.FederationParameters_FederationProviderName;
context.FederationParameters_FederationURN = this.FederationParameters_FederationURN;
context.FederationParameters_SamlMetadataDocument = this.FederationParameters_SamlMetadataDocument;
context.FederationParameters_SamlMetadataURL = this.FederationParameters_SamlMetadataURL;
context.KmsKeyId = this.KmsKeyId;
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.SuperuserParameters_EmailAddress = this.SuperuserParameters_EmailAddress;
context.SuperuserParameters_FirstName = this.SuperuserParameters_FirstName;
context.SuperuserParameters_LastName = this.SuperuserParameters_LastName;
if (this.Tag != null)
{
context.Tag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Tag.Keys)
{
context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey]));
}
}
// 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.Finspace.Model.CreateEnvironmentRequest();
if (cmdletContext.DataBundle != null)
{
request.DataBundles = cmdletContext.DataBundle;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.FederationMode != null)
{
request.FederationMode = cmdletContext.FederationMode;
}
// populate FederationParameters
var requestFederationParametersIsNull = true;
request.FederationParameters = new Amazon.Finspace.Model.FederationParameters();
System.String requestFederationParameters_federationParameters_ApplicationCallBackURL = null;
if (cmdletContext.FederationParameters_ApplicationCallBackURL != null)
{
requestFederationParameters_federationParameters_ApplicationCallBackURL = cmdletContext.FederationParameters_ApplicationCallBackURL;
}
if (requestFederationParameters_federationParameters_ApplicationCallBackURL != null)
{
request.FederationParameters.ApplicationCallBackURL = requestFederationParameters_federationParameters_ApplicationCallBackURL;
requestFederationParametersIsNull = false;
}
Dictionary requestFederationParameters_federationParameters_AttributeMap = null;
if (cmdletContext.FederationParameters_AttributeMap != null)
{
requestFederationParameters_federationParameters_AttributeMap = cmdletContext.FederationParameters_AttributeMap;
}
if (requestFederationParameters_federationParameters_AttributeMap != null)
{
request.FederationParameters.AttributeMap = requestFederationParameters_federationParameters_AttributeMap;
requestFederationParametersIsNull = false;
}
System.String requestFederationParameters_federationParameters_FederationProviderName = null;
if (cmdletContext.FederationParameters_FederationProviderName != null)
{
requestFederationParameters_federationParameters_FederationProviderName = cmdletContext.FederationParameters_FederationProviderName;
}
if (requestFederationParameters_federationParameters_FederationProviderName != null)
{
request.FederationParameters.FederationProviderName = requestFederationParameters_federationParameters_FederationProviderName;
requestFederationParametersIsNull = false;
}
System.String requestFederationParameters_federationParameters_FederationURN = null;
if (cmdletContext.FederationParameters_FederationURN != null)
{
requestFederationParameters_federationParameters_FederationURN = cmdletContext.FederationParameters_FederationURN;
}
if (requestFederationParameters_federationParameters_FederationURN != null)
{
request.FederationParameters.FederationURN = requestFederationParameters_federationParameters_FederationURN;
requestFederationParametersIsNull = false;
}
System.String requestFederationParameters_federationParameters_SamlMetadataDocument = null;
if (cmdletContext.FederationParameters_SamlMetadataDocument != null)
{
requestFederationParameters_federationParameters_SamlMetadataDocument = cmdletContext.FederationParameters_SamlMetadataDocument;
}
if (requestFederationParameters_federationParameters_SamlMetadataDocument != null)
{
request.FederationParameters.SamlMetadataDocument = requestFederationParameters_federationParameters_SamlMetadataDocument;
requestFederationParametersIsNull = false;
}
System.String requestFederationParameters_federationParameters_SamlMetadataURL = null;
if (cmdletContext.FederationParameters_SamlMetadataURL != null)
{
requestFederationParameters_federationParameters_SamlMetadataURL = cmdletContext.FederationParameters_SamlMetadataURL;
}
if (requestFederationParameters_federationParameters_SamlMetadataURL != null)
{
request.FederationParameters.SamlMetadataURL = requestFederationParameters_federationParameters_SamlMetadataURL;
requestFederationParametersIsNull = false;
}
// determine if request.FederationParameters should be set to null
if (requestFederationParametersIsNull)
{
request.FederationParameters = null;
}
if (cmdletContext.KmsKeyId != null)
{
request.KmsKeyId = cmdletContext.KmsKeyId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
// populate SuperuserParameters
var requestSuperuserParametersIsNull = true;
request.SuperuserParameters = new Amazon.Finspace.Model.SuperuserParameters();
System.String requestSuperuserParameters_superuserParameters_EmailAddress = null;
if (cmdletContext.SuperuserParameters_EmailAddress != null)
{
requestSuperuserParameters_superuserParameters_EmailAddress = cmdletContext.SuperuserParameters_EmailAddress;
}
if (requestSuperuserParameters_superuserParameters_EmailAddress != null)
{
request.SuperuserParameters.EmailAddress = requestSuperuserParameters_superuserParameters_EmailAddress;
requestSuperuserParametersIsNull = false;
}
System.String requestSuperuserParameters_superuserParameters_FirstName = null;
if (cmdletContext.SuperuserParameters_FirstName != null)
{
requestSuperuserParameters_superuserParameters_FirstName = cmdletContext.SuperuserParameters_FirstName;
}
if (requestSuperuserParameters_superuserParameters_FirstName != null)
{
request.SuperuserParameters.FirstName = requestSuperuserParameters_superuserParameters_FirstName;
requestSuperuserParametersIsNull = false;
}
System.String requestSuperuserParameters_superuserParameters_LastName = null;
if (cmdletContext.SuperuserParameters_LastName != null)
{
requestSuperuserParameters_superuserParameters_LastName = cmdletContext.SuperuserParameters_LastName;
}
if (requestSuperuserParameters_superuserParameters_LastName != null)
{
request.SuperuserParameters.LastName = requestSuperuserParameters_superuserParameters_LastName;
requestSuperuserParametersIsNull = false;
}
// determine if request.SuperuserParameters should be set to null
if (requestSuperuserParametersIsNull)
{
request.SuperuserParameters = null;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.Finspace.Model.CreateEnvironmentResponse CallAWSServiceOperation(IAmazonFinspace client, Amazon.Finspace.Model.CreateEnvironmentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "FinSpace User Environment Management Service", "CreateEnvironment");
try
{
#if DESKTOP
return client.CreateEnvironment(request);
#elif CORECLR
return client.CreateEnvironmentAsync(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 DataBundle { get; set; }
public System.String Description { get; set; }
public Amazon.Finspace.FederationMode FederationMode { get; set; }
public System.String FederationParameters_ApplicationCallBackURL { get; set; }
public Dictionary FederationParameters_AttributeMap { get; set; }
public System.String FederationParameters_FederationProviderName { get; set; }
public System.String FederationParameters_FederationURN { get; set; }
public System.String FederationParameters_SamlMetadataDocument { get; set; }
public System.String FederationParameters_SamlMetadataURL { get; set; }
public System.String KmsKeyId { get; set; }
public System.String Name { get; set; }
public System.String SuperuserParameters_EmailAddress { get; set; }
public System.String SuperuserParameters_FirstName { get; set; }
public System.String SuperuserParameters_LastName { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}