/*******************************************************************************
* 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.Redshift;
using Amazon.Redshift.Model;
namespace Amazon.PowerShell.Cmdlets.RS
{
///
/// Returns a database user name and temporary password with temporary authorization to
/// log on to an Amazon Redshift database. The action returns the database user name prefixed
/// with IAM:
if AutoCreate
is False
or IAMA:
/// if AutoCreate
is True
. You can optionally specify one or
/// more database user groups that the user will join at log on. By default, the temporary
/// credentials expire in 900 seconds. You can optionally specify a duration between 900
/// seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using
/// IAM Authentication to Generate Database User Credentials in the Amazon Redshift
/// Cluster Management Guide.
///
///
///
/// The Identity and Access Management (IAM) user or role that runs GetClusterCredentials
/// must have an IAM policy attached that allows access to all necessary actions and resources.
/// For more information about permissions, see Resource
/// Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
///
/// If the DbGroups
parameter is specified, the IAM policy must allow the
/// redshift:JoinGroup
action with access to the listed dbgroups
.
///
///
/// In addition, if the AutoCreate
parameter is set to True
,
/// then the policy must include the redshift:CreateClusterUser
permission.
///
/// If the DbName
parameter is specified, the IAM policy must allow access
/// to the resource dbname
for the specified database name.
///
///
[Cmdlet("Get", "RSClusterCredential")]
[OutputType("Amazon.Redshift.Model.GetClusterCredentialsResponse")]
[AWSCmdlet("Calls the Amazon Redshift GetClusterCredentials API operation.", Operation = new[] {"GetClusterCredentials"}, SelectReturnType = typeof(Amazon.Redshift.Model.GetClusterCredentialsResponse))]
[AWSCmdletOutput("Amazon.Redshift.Model.GetClusterCredentialsResponse",
"This cmdlet returns an Amazon.Redshift.Model.GetClusterCredentialsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRSClusterCredentialCmdlet : AmazonRedshiftClientCmdlet, IExecutor
{
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter AutoCreate
///
///
/// Create a database user with the name specified for the user named in DbUser
/// if one does not exist.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? AutoCreate { get; set; }
#endregion
#region Parameter ClusterIdentifier
///
///
/// The unique identifier of the cluster that contains the database for which you are
/// requesting credentials. This parameter is case sensitive.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String ClusterIdentifier { get; set; }
#endregion
#region Parameter CustomDomainName
///
///
/// The custom domain name for the cluster credentials.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CustomDomainName { get; set; }
#endregion
#region Parameter DbGroup
///
///
/// A list of the names of existing database groups that the user named in DbUser
/// will join for the current session, in addition to any group memberships for an existing
/// user. If not specified, a new user is added only to PUBLIC.Database group name constraints- Must be 1 to 64 alphanumeric characters or hyphens
- Must contain only lowercase letters, numbers, underscore, plus sign, period (dot),
/// at symbol (@), or hyphen.
- First character must be a letter.
- Must not contain a colon ( : ) or slash ( / ).
- Cannot be a reserved word. A list of reserved words can be found in Reserved
/// Words in the Amazon Redshift Database Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DbGroups")]
public System.String[] DbGroup { get; set; }
#endregion
#region Parameter DbName
///
///
/// The name of a database that DbUser
is authorized to log on to. If DbName
/// is not specified, DbUser
can log on to any existing database.Constraints:- Must be 1 to 64 alphanumeric characters or hyphens
- Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
/// (dot), at symbol (@), or hyphen.
- First character must be a letter.
- Must not contain a colon ( : ) or slash ( / ).
- Cannot be a reserved word. A list of reserved words can be found in Reserved
/// Words in the Amazon Redshift Database Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DbName { get; set; }
#endregion
#region Parameter DbUser
///
///
/// The name of a database user. If a user name matching DbUser
exists in
/// the database, the temporary user credentials have the same permissions as the existing
/// user. If DbUser
doesn't exist in the database and Autocreate
/// is True
, a new user is created using the value for DbUser
/// with PUBLIC permissions. If a database user matching the value for DbUser
/// doesn't exist and Autocreate
is False
, then the command
/// succeeds but the connection attempt will fail because the user doesn't exist in the
/// database.For more information, see CREATE
/// USER in the Amazon Redshift Database Developer Guide. Constraints:- Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. - Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
/// (dot), at symbol (@), or hyphen.
- First character must be a letter.
- Must not contain a colon ( : ) or slash ( / ).
- Cannot be a reserved word. A list of reserved words can be found in Reserved
/// Words in the Amazon Redshift Database Developer Guide.
///
///
#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 DbUser { get; set; }
#endregion
#region Parameter DurationSecond
///
///
/// The number of seconds until the returned temporary password expires.Constraint: minimum 900, maximum 3600.Default: 900
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DurationSeconds")]
public System.Int32? DurationSecond { 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.Redshift.Model.GetClusterCredentialsResponse).
/// Specifying the name of a property of type Amazon.Redshift.Model.GetClusterCredentialsResponse 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 ClusterIdentifier parameter.
/// The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.ClusterIdentifier;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AutoCreate = this.AutoCreate;
context.ClusterIdentifier = this.ClusterIdentifier;
context.CustomDomainName = this.CustomDomainName;
if (this.DbGroup != null)
{
context.DbGroup = new List(this.DbGroup);
}
context.DbName = this.DbName;
context.DbUser = this.DbUser;
#if MODULAR
if (this.DbUser == null && ParameterWasBound(nameof(this.DbUser)))
{
WriteWarning("You are passing $null as a value for parameter DbUser 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.DurationSecond = this.DurationSecond;
// 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.Redshift.Model.GetClusterCredentialsRequest();
if (cmdletContext.AutoCreate != null)
{
request.AutoCreate = cmdletContext.AutoCreate.Value;
}
if (cmdletContext.ClusterIdentifier != null)
{
request.ClusterIdentifier = cmdletContext.ClusterIdentifier;
}
if (cmdletContext.CustomDomainName != null)
{
request.CustomDomainName = cmdletContext.CustomDomainName;
}
if (cmdletContext.DbGroup != null)
{
request.DbGroups = cmdletContext.DbGroup;
}
if (cmdletContext.DbName != null)
{
request.DbName = cmdletContext.DbName;
}
if (cmdletContext.DbUser != null)
{
request.DbUser = cmdletContext.DbUser;
}
if (cmdletContext.DurationSecond != null)
{
request.DurationSeconds = cmdletContext.DurationSecond.Value;
}
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.Redshift.Model.GetClusterCredentialsResponse CallAWSServiceOperation(IAmazonRedshift client, Amazon.Redshift.Model.GetClusterCredentialsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Redshift", "GetClusterCredentials");
try
{
#if DESKTOP
return client.GetClusterCredentials(request);
#elif CORECLR
return client.GetClusterCredentialsAsync(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.Boolean? AutoCreate { get; set; }
public System.String ClusterIdentifier { get; set; }
public System.String CustomDomainName { get; set; }
public List DbGroup { get; set; }
public System.String DbName { get; set; }
public System.String DbUser { get; set; }
public System.Int32? DurationSecond { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}