/*******************************************************************************
* 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 an IAM role that is linked to a specific Amazon Web Services service. The
/// service controls the attached policies and when the role can be deleted. This helps
/// ensure that the service is not broken by an unexpectedly changed or deleted role,
/// which could put your Amazon Web Services resources into an unknown state. Allowing
/// the service to control the role helps improve service stability and proper cleanup
/// when a service and its role are no longer needed. For more information, see Using
/// service-linked roles in the IAM User Guide.
///
///
///
/// To attach a policy to this service-linked role, you must make the request using the
/// Amazon Web Services service that depends on this role.
///
///
[Cmdlet("New", "IAMServiceLinkedRole", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.IdentityManagement.Model.Role")]
[AWSCmdlet("Calls the AWS Identity and Access Management CreateServiceLinkedRole API operation.", Operation = new[] {"CreateServiceLinkedRole"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.CreateServiceLinkedRoleResponse))]
[AWSCmdletOutput("Amazon.IdentityManagement.Model.Role or Amazon.IdentityManagement.Model.CreateServiceLinkedRoleResponse",
"This cmdlet returns an Amazon.IdentityManagement.Model.Role object.",
"The service call response (type Amazon.IdentityManagement.Model.CreateServiceLinkedRoleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewIAMServiceLinkedRoleCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor
{
#region Parameter AWSServiceName
///
///
/// The service principal for the Amazon Web Services service to which this role is attached.
/// You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com
.
/// Service principals are unique and case-sensitive. To find the exact service principal
/// for your service-linked role, see Amazon
/// Web Services services that work with IAM in the IAM User Guide. Look for
/// the services that have Yes in the Service-Linked Role column. Choose
/// the Yes link to view the service-linked role documentation for that service.
///
///
#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 AWSServiceName { get; set; }
#endregion
#region Parameter CustomSuffix
///
///
/// A string that you provide, which is combined with the service-provided prefix to form
/// the complete role name. If you make multiple requests for the same service, then you
/// must supply a different CustomSuffix
for each request. Otherwise the
/// request fails with a duplicate role name error. For example, you could add -1
/// or -debug
to the suffix.Some services do not support the CustomSuffix
parameter. If you provide
/// an optional suffix and the operation fails, try the operation again without the suffix.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CustomSuffix { get; set; }
#endregion
#region Parameter Description
///
///
/// The description of the role.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Role'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityManagement.Model.CreateServiceLinkedRoleResponse).
/// Specifying the name of a property of type Amazon.IdentityManagement.Model.CreateServiceLinkedRoleResponse 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; } = "Role";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the AWSServiceName parameter.
/// The -PassThru parameter is deprecated, use -Select '^AWSServiceName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^AWSServiceName' 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.AWSServiceName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-IAMServiceLinkedRole (CreateServiceLinkedRole)"))
{
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.AWSServiceName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AWSServiceName = this.AWSServiceName;
#if MODULAR
if (this.AWSServiceName == null && ParameterWasBound(nameof(this.AWSServiceName)))
{
WriteWarning("You are passing $null as a value for parameter AWSServiceName 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.CustomSuffix = this.CustomSuffix;
context.Description = this.Description;
// 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.CreateServiceLinkedRoleRequest();
if (cmdletContext.AWSServiceName != null)
{
request.AWSServiceName = cmdletContext.AWSServiceName;
}
if (cmdletContext.CustomSuffix != null)
{
request.CustomSuffix = cmdletContext.CustomSuffix;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
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.CreateServiceLinkedRoleResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.CreateServiceLinkedRoleRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "CreateServiceLinkedRole");
try
{
#if DESKTOP
return client.CreateServiceLinkedRole(request);
#elif CORECLR
return client.CreateServiceLinkedRoleAsync(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 AWSServiceName { get; set; }
public System.String CustomSuffix { get; set; }
public System.String Description { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Role;
}
}
}