/*******************************************************************************
* 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.ConfigService;
using Amazon.ConfigService.Model;
namespace Amazon.PowerShell.Cmdlets.CFG
{
///
/// Deploys conformance packs across member accounts in an Amazon Web Services Organization.
/// For information on how many organization conformance packs and how many Config rules
/// you can have per account, see Service Limits in the Config Developer Guide.
///
///
///
/// Only a management account and a delegated administrator can call this API. When calling
/// this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
/// permissions are added. An organization can have up to 3 delegated administrators.
///
/// This API enables organization service access for config-multiaccountsetup.amazonaws.com
/// through the EnableAWSServiceAccess
action and creates a service-linked
/// role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated
/// administrator account of your organization. The service-linked role is created only
/// when the role does not exist in the caller account. To use this API with delegated
/// administrator, register a delegated administrator by calling Amazon Web Services Organization
/// register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
///
/// Prerequisite: Ensure you call EnableAllFeatures
API to enable all features
/// in an organization.
///
/// You must specify either the TemplateS3Uri
or the TemplateBody
/// parameter, but not both. If you provide both Config uses the TemplateS3Uri
/// parameter and ignores the TemplateBody
parameter.
///
/// Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS
/// until the conformance pack is created or updated. You cannot update a conformance
/// pack while it is in this state.
///
///
[Cmdlet("Write", "CFGOrganizationConformancePack", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Config PutOrganizationConformancePack API operation.", Operation = new[] {"PutOrganizationConformancePack"}, SelectReturnType = typeof(Amazon.ConfigService.Model.PutOrganizationConformancePackResponse))]
[AWSCmdletOutput("System.String or Amazon.ConfigService.Model.PutOrganizationConformancePackResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.ConfigService.Model.PutOrganizationConformancePackResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteCFGOrganizationConformancePackCmdlet : AmazonConfigServiceClientCmdlet, IExecutor
{
#region Parameter ConformancePackInputParameter
///
///
/// A list of ConformancePackInputParameter
objects.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ConformancePackInputParameters")]
public Amazon.ConfigService.Model.ConformancePackInputParameter[] ConformancePackInputParameter { get; set; }
#endregion
#region Parameter DeliveryS3Bucket
///
///
/// The name of the Amazon S3 bucket where Config stores conformance pack templates.This field is optional. If used, it must be prefixed with awsconfigconforms
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryS3Bucket { get; set; }
#endregion
#region Parameter DeliveryS3KeyPrefix
///
///
/// The prefix for the Amazon S3 bucket.This field is optional.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryS3KeyPrefix { get; set; }
#endregion
#region Parameter ExcludedAccount
///
///
/// A list of Amazon Web Services accounts to be excluded from an organization conformance
/// pack while deploying a conformance pack.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ExcludedAccounts")]
public System.String[] ExcludedAccount { get; set; }
#endregion
#region Parameter OrganizationConformancePackName
///
///
/// Name of the organization conformance pack you want to create.
///
///
#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 OrganizationConformancePackName { get; set; }
#endregion
#region Parameter TemplateBody
///
///
/// A string containing full conformance pack template body. Structure containing the
/// template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TemplateBody { get; set; }
#endregion
#region Parameter TemplateS3Uri
///
///
/// Location of file containing the template body. The uri must point to the conformance
/// pack template (max size: 300 KB).You must have access to read Amazon S3 bucket.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TemplateS3Uri { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'OrganizationConformancePackArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutOrganizationConformancePackResponse).
/// Specifying the name of a property of type Amazon.ConfigService.Model.PutOrganizationConformancePackResponse 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; } = "OrganizationConformancePackArn";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the OrganizationConformancePackName parameter.
/// The -PassThru parameter is deprecated, use -Select '^OrganizationConformancePackName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^OrganizationConformancePackName' 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.OrganizationConformancePackName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CFGOrganizationConformancePack (PutOrganizationConformancePack)"))
{
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.OrganizationConformancePackName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.ConformancePackInputParameter != null)
{
context.ConformancePackInputParameter = new List(this.ConformancePackInputParameter);
}
context.DeliveryS3Bucket = this.DeliveryS3Bucket;
context.DeliveryS3KeyPrefix = this.DeliveryS3KeyPrefix;
if (this.ExcludedAccount != null)
{
context.ExcludedAccount = new List(this.ExcludedAccount);
}
context.OrganizationConformancePackName = this.OrganizationConformancePackName;
#if MODULAR
if (this.OrganizationConformancePackName == null && ParameterWasBound(nameof(this.OrganizationConformancePackName)))
{
WriteWarning("You are passing $null as a value for parameter OrganizationConformancePackName 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.TemplateBody = this.TemplateBody;
context.TemplateS3Uri = this.TemplateS3Uri;
// 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.ConfigService.Model.PutOrganizationConformancePackRequest();
if (cmdletContext.ConformancePackInputParameter != null)
{
request.ConformancePackInputParameters = cmdletContext.ConformancePackInputParameter;
}
if (cmdletContext.DeliveryS3Bucket != null)
{
request.DeliveryS3Bucket = cmdletContext.DeliveryS3Bucket;
}
if (cmdletContext.DeliveryS3KeyPrefix != null)
{
request.DeliveryS3KeyPrefix = cmdletContext.DeliveryS3KeyPrefix;
}
if (cmdletContext.ExcludedAccount != null)
{
request.ExcludedAccounts = cmdletContext.ExcludedAccount;
}
if (cmdletContext.OrganizationConformancePackName != null)
{
request.OrganizationConformancePackName = cmdletContext.OrganizationConformancePackName;
}
if (cmdletContext.TemplateBody != null)
{
request.TemplateBody = cmdletContext.TemplateBody;
}
if (cmdletContext.TemplateS3Uri != null)
{
request.TemplateS3Uri = cmdletContext.TemplateS3Uri;
}
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.ConfigService.Model.PutOrganizationConformancePackResponse CallAWSServiceOperation(IAmazonConfigService client, Amazon.ConfigService.Model.PutOrganizationConformancePackRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Config", "PutOrganizationConformancePack");
try
{
#if DESKTOP
return client.PutOrganizationConformancePack(request);
#elif CORECLR
return client.PutOrganizationConformancePackAsync(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 ConformancePackInputParameter { get; set; }
public System.String DeliveryS3Bucket { get; set; }
public System.String DeliveryS3KeyPrefix { get; set; }
public List ExcludedAccount { get; set; }
public System.String OrganizationConformancePackName { get; set; }
public System.String TemplateBody { get; set; }
public System.String TemplateS3Uri { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.OrganizationConformancePackArn;
}
}
}