/*******************************************************************************
* 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.IdentityManagement;
using Amazon.IdentityManagement.Model;
namespace Amazon.PowerShell.Cmdlets.IAM
{
///
/// Creates a new version of the specified managed policy. To update a managed policy,
/// you create a new policy version. A managed policy can have up to five versions. If
/// the policy has five versions, you must delete an existing version using DeletePolicyVersion
/// before you create a new version.
///
///
///
/// Optionally, you can set the new version as the policy's default version. The default
/// version is the version that is in effect for the IAM users, groups, and roles to which
/// the policy is attached.
///
/// For more information about managed policy versions, see Versioning
/// for managed policies in the IAM User Guide.
///
///
[Cmdlet("New", "IAMPolicyVersion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.IdentityManagement.Model.PolicyVersion")]
[AWSCmdlet("Calls the AWS Identity and Access Management CreatePolicyVersion API operation.", Operation = new[] {"CreatePolicyVersion"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.CreatePolicyVersionResponse))]
[AWSCmdletOutput("Amazon.IdentityManagement.Model.PolicyVersion or Amazon.IdentityManagement.Model.CreatePolicyVersionResponse",
"This cmdlet returns an Amazon.IdentityManagement.Model.PolicyVersion object.",
"The service call response (type Amazon.IdentityManagement.Model.CreatePolicyVersionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewIAMPolicyVersionCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor
{
#region Parameter PolicyArn
///
///
/// The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.For more information about ARNs, see Amazon
/// Resource Names (ARNs) in the Amazon Web Services General Reference.
///
///
#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 PolicyArn { get; set; }
#endregion
#region Parameter PolicyDocument
///
///
/// The JSON policy document that you want to use as the content for this new version
/// of the policy.You must provide policies in JSON format in IAM. However, for CloudFormation templates
/// formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation
/// always converts a YAML policy to JSON format before submitting it to IAM.The maximum length of the policy document that you can pass in this operation, including
/// whitespace, is listed below. To view the maximum character counts of a managed policy
/// with no whitespaces, see IAM
/// and STS character quotas.The regex pattern used to validate this
/// parameter is a string of characters consisting of the following:- Any printable ASCII character ranging from the space character (
\u0020
)
/// through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement character set (through
///
\u00FF
) - The special characters tab (
\u0009
), line feed (\u000A
),
/// and carriage return (\u000D
)
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String PolicyDocument { get; set; }
#endregion
#region Parameter SetAsDefault
///
///
/// Specifies whether to set this version as the policy's default version.When this parameter is true
, the new policy version becomes the operative
/// version. That is, it becomes the version that is in effect for the IAM users, groups,
/// and roles that the policy is attached to.For more information about managed policy versions, see Versioning
/// for managed policies in the IAM User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? SetAsDefault { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'PolicyVersion'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityManagement.Model.CreatePolicyVersionResponse).
/// Specifying the name of a property of type Amazon.IdentityManagement.Model.CreatePolicyVersionResponse 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; } = "PolicyVersion";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the PolicyArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^PolicyArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^PolicyArn' 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.PolicyArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-IAMPolicyVersion (CreatePolicyVersion)"))
{
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.PolicyArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.PolicyArn = this.PolicyArn;
#if MODULAR
if (this.PolicyArn == null && ParameterWasBound(nameof(this.PolicyArn)))
{
WriteWarning("You are passing $null as a value for parameter PolicyArn 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.PolicyDocument = this.PolicyDocument;
#if MODULAR
if (this.PolicyDocument == null && ParameterWasBound(nameof(this.PolicyDocument)))
{
WriteWarning("You are passing $null as a value for parameter PolicyDocument 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.SetAsDefault = this.SetAsDefault;
// 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.IdentityManagement.Model.CreatePolicyVersionRequest();
if (cmdletContext.PolicyArn != null)
{
request.PolicyArn = cmdletContext.PolicyArn;
}
if (cmdletContext.PolicyDocument != null)
{
request.PolicyDocument = cmdletContext.PolicyDocument;
}
if (cmdletContext.SetAsDefault != null)
{
request.SetAsDefault = cmdletContext.SetAsDefault.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.IdentityManagement.Model.CreatePolicyVersionResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.CreatePolicyVersionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "CreatePolicyVersion");
try
{
#if DESKTOP
return client.CreatePolicyVersion(request);
#elif CORECLR
return client.CreatePolicyVersionAsync(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 PolicyArn { get; set; }
public System.String PolicyDocument { get; set; }
public System.Boolean? SetAsDefault { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.PolicyVersion;
}
}
}