/*******************************************************************************
* 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.CognitoIdentityProvider;
using Amazon.CognitoIdentityProvider.Model;
namespace Amazon.PowerShell.Cmdlets.CGIP
{
///
/// Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your
/// user pool.
///
///
///
/// You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate
/// to Amazon Cognito. You can't use it to change the domain for a user pool.
///
/// A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up
/// and sign-in pages for your application. When you set up a custom domain, you provide
/// a certificate that you manage with Certificate Manager (ACM). When necessary, you
/// can use this operation to change the certificate that you applied to your custom domain.
///
/// Usually, this is unnecessary following routine certificate renewal with ACM. When
/// you renew your existing certificate in ACM, the ARN for your certificate remains the
/// same, and your custom domain uses the new certificate automatically.
///
/// However, if you replace your existing certificate with a new one, ACM gives the new
/// certificate a new ARN. To apply the new certificate to your custom domain, you must
/// provide this ARN to Amazon Cognito.
///
/// When you add your new certificate in ACM, you must choose US East (N. Virginia) as
/// the Amazon Web Services Region.
///
/// After you submit your request, Amazon Cognito requires up to 1 hour to distribute
/// your new certificate to your custom domain.
///
/// For more information about adding a custom domain to your user pool, see Using
/// Your Own Domain for the Hosted UI.
///
///
[Cmdlet("Update", "CGIPUserPoolDomain", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Cognito Identity Provider UpdateUserPoolDomain API operation.", Operation = new[] {"UpdateUserPoolDomain"}, SelectReturnType = typeof(Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse))]
[AWSCmdletOutput("System.String or Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateCGIPUserPoolDomainCmdlet : AmazonCognitoIdentityProviderClientCmdlet, IExecutor
{
#region Parameter CustomDomainConfig_CertificateArn
///
///
/// The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use
/// this certificate for the subdomain of your custom domain.
///
///
#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 CustomDomainConfig_CertificateArn { get; set; }
#endregion
#region Parameter Domain
///
///
/// The domain name for the custom domain that hosts the sign-up and sign-in pages for
/// your application. One example might be auth.example.com
. This string can include only lowercase letters, numbers, and hyphens. Don't use a
/// hyphen for the first or last character. Use periods to separate subdomain names.
///
///
#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 Domain { get; set; }
#endregion
#region Parameter UserPoolId
///
///
/// The ID of the user pool that is associated with the custom domain whose certificate
/// you're updating.
///
///
#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 UserPoolId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'CloudFrontDomain'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse).
/// Specifying the name of a property of type Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse 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; } = "CloudFrontDomain";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the UserPoolId parameter.
/// The -PassThru parameter is deprecated, use -Select '^UserPoolId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^UserPoolId' 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.UserPoolId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-CGIPUserPoolDomain (UpdateUserPoolDomain)"))
{
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.UserPoolId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CustomDomainConfig_CertificateArn = this.CustomDomainConfig_CertificateArn;
#if MODULAR
if (this.CustomDomainConfig_CertificateArn == null && ParameterWasBound(nameof(this.CustomDomainConfig_CertificateArn)))
{
WriteWarning("You are passing $null as a value for parameter CustomDomainConfig_CertificateArn 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.Domain = this.Domain;
#if MODULAR
if (this.Domain == null && ParameterWasBound(nameof(this.Domain)))
{
WriteWarning("You are passing $null as a value for parameter Domain 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.UserPoolId = this.UserPoolId;
#if MODULAR
if (this.UserPoolId == null && ParameterWasBound(nameof(this.UserPoolId)))
{
WriteWarning("You are passing $null as a value for parameter UserPoolId 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.CognitoIdentityProvider.Model.UpdateUserPoolDomainRequest();
// populate CustomDomainConfig
var requestCustomDomainConfigIsNull = true;
request.CustomDomainConfig = new Amazon.CognitoIdentityProvider.Model.CustomDomainConfigType();
System.String requestCustomDomainConfig_customDomainConfig_CertificateArn = null;
if (cmdletContext.CustomDomainConfig_CertificateArn != null)
{
requestCustomDomainConfig_customDomainConfig_CertificateArn = cmdletContext.CustomDomainConfig_CertificateArn;
}
if (requestCustomDomainConfig_customDomainConfig_CertificateArn != null)
{
request.CustomDomainConfig.CertificateArn = requestCustomDomainConfig_customDomainConfig_CertificateArn;
requestCustomDomainConfigIsNull = false;
}
// determine if request.CustomDomainConfig should be set to null
if (requestCustomDomainConfigIsNull)
{
request.CustomDomainConfig = null;
}
if (cmdletContext.Domain != null)
{
request.Domain = cmdletContext.Domain;
}
if (cmdletContext.UserPoolId != null)
{
request.UserPoolId = cmdletContext.UserPoolId;
}
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.CognitoIdentityProvider.Model.UpdateUserPoolDomainResponse CallAWSServiceOperation(IAmazonCognitoIdentityProvider client, Amazon.CognitoIdentityProvider.Model.UpdateUserPoolDomainRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Identity Provider", "UpdateUserPoolDomain");
try
{
#if DESKTOP
return client.UpdateUserPoolDomain(request);
#elif CORECLR
return client.UpdateUserPoolDomainAsync(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 CustomDomainConfig_CertificateArn { get; set; }
public System.String Domain { get; set; }
public System.String UserPoolId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.CloudFrontDomain;
}
}
}