/*******************************************************************************
* 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
{
///
/// Creates a delivery channel object to deliver configuration information to an Amazon
/// S3 bucket and Amazon SNS topic.
///
///
///
/// Before you can create a delivery channel, you must create a configuration recorder.
///
/// You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the
/// existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic,
/// call this action and specify the changed values for the S3 bucket and the SNS topic.
/// If you specify a different value for either the S3 bucket or the SNS topic, this action
/// will keep the existing value for the parameter that is not changed.
///
/// You can have only one delivery channel per region in your account.
///
///
[Cmdlet("Write", "CFGDeliveryChannel", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the AWS Config PutDeliveryChannel API operation.", Operation = new[] {"PutDeliveryChannel"}, SelectReturnType = typeof(Amazon.ConfigService.Model.PutDeliveryChannelResponse))]
[AWSCmdletOutput("None or Amazon.ConfigService.Model.PutDeliveryChannelResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.ConfigService.Model.PutDeliveryChannelResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteCFGDeliveryChannelCmdlet : AmazonConfigServiceClientCmdlet, IExecutor
{
#region Parameter ConfigSnapshotDeliveryProperties_DeliveryFrequency
///
///
/// The frequency with which Config delivers configuration snapshots.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DeliveryChannel_ConfigSnapshotDeliveryProperties_DeliveryFrequency")]
[AWSConstantClassSource("Amazon.ConfigService.MaximumExecutionFrequency")]
public Amazon.ConfigService.MaximumExecutionFrequency ConfigSnapshotDeliveryProperties_DeliveryFrequency { get; set; }
#endregion
#region Parameter DeliveryChannelName
///
///
/// The name of the delivery channel. By default, Config assigns the name "default" when
/// creating the delivery channel. To change the delivery channel name, you must use the
/// DeleteDeliveryChannel action to delete your current delivery channel, and then you
/// must use the PutDeliveryChannel command to create a delivery channel that has the
/// desired name.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[Alias("DeliveryChannel_Name")]
public System.String DeliveryChannelName { get; set; }
#endregion
#region Parameter DeliveryChannel_S3BucketName
///
///
/// The name of the Amazon S3 bucket to which Config delivers configuration snapshots
/// and configuration history files.If you specify a bucket that belongs to another Amazon Web Services account, that
/// bucket must have policies that grant access permissions to Config. For more information,
/// see Permissions
/// for the Amazon S3 Bucket in the Config Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryChannel_S3BucketName { get; set; }
#endregion
#region Parameter DeliveryChannel_S3KeyPrefix
///
///
/// The prefix for the specified Amazon S3 bucket.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryChannel_S3KeyPrefix { get; set; }
#endregion
#region Parameter DeliveryChannel_S3KmsKeyArn
///
///
/// The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key)
/// used to encrypt objects delivered by Config. Must belong to the same Region as the
/// destination S3 bucket.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryChannel_S3KmsKeyArn { get; set; }
#endregion
#region Parameter DeliveryChannel_SnsTopicARN
///
///
/// The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications
/// about configuration changes.If you choose a topic from another account, the topic must have policies that grant
/// access permissions to Config. For more information, see Permissions
/// for the Amazon SNS Topic in the Config Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeliveryChannel_SnsTopicARN { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConfigService.Model.PutDeliveryChannelResponse).
/// 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 DeliveryChannelName parameter.
/// The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DeliveryChannelName' 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.DeliveryChannelName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-CFGDeliveryChannel (PutDeliveryChannel)"))
{
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.DeliveryChannelName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ConfigSnapshotDeliveryProperties_DeliveryFrequency = this.ConfigSnapshotDeliveryProperties_DeliveryFrequency;
context.DeliveryChannelName = this.DeliveryChannelName;
context.DeliveryChannel_S3BucketName = this.DeliveryChannel_S3BucketName;
context.DeliveryChannel_S3KeyPrefix = this.DeliveryChannel_S3KeyPrefix;
context.DeliveryChannel_S3KmsKeyArn = this.DeliveryChannel_S3KmsKeyArn;
context.DeliveryChannel_SnsTopicARN = this.DeliveryChannel_SnsTopicARN;
// 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.PutDeliveryChannelRequest();
// populate DeliveryChannel
var requestDeliveryChannelIsNull = true;
request.DeliveryChannel = new Amazon.ConfigService.Model.DeliveryChannel();
System.String requestDeliveryChannel_deliveryChannelName = null;
if (cmdletContext.DeliveryChannelName != null)
{
requestDeliveryChannel_deliveryChannelName = cmdletContext.DeliveryChannelName;
}
if (requestDeliveryChannel_deliveryChannelName != null)
{
request.DeliveryChannel.Name = requestDeliveryChannel_deliveryChannelName;
requestDeliveryChannelIsNull = false;
}
System.String requestDeliveryChannel_deliveryChannel_S3BucketName = null;
if (cmdletContext.DeliveryChannel_S3BucketName != null)
{
requestDeliveryChannel_deliveryChannel_S3BucketName = cmdletContext.DeliveryChannel_S3BucketName;
}
if (requestDeliveryChannel_deliveryChannel_S3BucketName != null)
{
request.DeliveryChannel.S3BucketName = requestDeliveryChannel_deliveryChannel_S3BucketName;
requestDeliveryChannelIsNull = false;
}
System.String requestDeliveryChannel_deliveryChannel_S3KeyPrefix = null;
if (cmdletContext.DeliveryChannel_S3KeyPrefix != null)
{
requestDeliveryChannel_deliveryChannel_S3KeyPrefix = cmdletContext.DeliveryChannel_S3KeyPrefix;
}
if (requestDeliveryChannel_deliveryChannel_S3KeyPrefix != null)
{
request.DeliveryChannel.S3KeyPrefix = requestDeliveryChannel_deliveryChannel_S3KeyPrefix;
requestDeliveryChannelIsNull = false;
}
System.String requestDeliveryChannel_deliveryChannel_S3KmsKeyArn = null;
if (cmdletContext.DeliveryChannel_S3KmsKeyArn != null)
{
requestDeliveryChannel_deliveryChannel_S3KmsKeyArn = cmdletContext.DeliveryChannel_S3KmsKeyArn;
}
if (requestDeliveryChannel_deliveryChannel_S3KmsKeyArn != null)
{
request.DeliveryChannel.S3KmsKeyArn = requestDeliveryChannel_deliveryChannel_S3KmsKeyArn;
requestDeliveryChannelIsNull = false;
}
System.String requestDeliveryChannel_deliveryChannel_SnsTopicARN = null;
if (cmdletContext.DeliveryChannel_SnsTopicARN != null)
{
requestDeliveryChannel_deliveryChannel_SnsTopicARN = cmdletContext.DeliveryChannel_SnsTopicARN;
}
if (requestDeliveryChannel_deliveryChannel_SnsTopicARN != null)
{
request.DeliveryChannel.SnsTopicARN = requestDeliveryChannel_deliveryChannel_SnsTopicARN;
requestDeliveryChannelIsNull = false;
}
Amazon.ConfigService.Model.ConfigSnapshotDeliveryProperties requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties = null;
// populate ConfigSnapshotDeliveryProperties
var requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryPropertiesIsNull = true;
requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties = new Amazon.ConfigService.Model.ConfigSnapshotDeliveryProperties();
Amazon.ConfigService.MaximumExecutionFrequency requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties_configSnapshotDeliveryProperties_DeliveryFrequency = null;
if (cmdletContext.ConfigSnapshotDeliveryProperties_DeliveryFrequency != null)
{
requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties_configSnapshotDeliveryProperties_DeliveryFrequency = cmdletContext.ConfigSnapshotDeliveryProperties_DeliveryFrequency;
}
if (requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties_configSnapshotDeliveryProperties_DeliveryFrequency != null)
{
requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties.DeliveryFrequency = requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties_configSnapshotDeliveryProperties_DeliveryFrequency;
requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryPropertiesIsNull = false;
}
// determine if requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties should be set to null
if (requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryPropertiesIsNull)
{
requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties = null;
}
if (requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties != null)
{
request.DeliveryChannel.ConfigSnapshotDeliveryProperties = requestDeliveryChannel_deliveryChannel_ConfigSnapshotDeliveryProperties;
requestDeliveryChannelIsNull = false;
}
// determine if request.DeliveryChannel should be set to null
if (requestDeliveryChannelIsNull)
{
request.DeliveryChannel = null;
}
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.PutDeliveryChannelResponse CallAWSServiceOperation(IAmazonConfigService client, Amazon.ConfigService.Model.PutDeliveryChannelRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Config", "PutDeliveryChannel");
try
{
#if DESKTOP
return client.PutDeliveryChannel(request);
#elif CORECLR
return client.PutDeliveryChannelAsync(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 Amazon.ConfigService.MaximumExecutionFrequency ConfigSnapshotDeliveryProperties_DeliveryFrequency { get; set; }
public System.String DeliveryChannelName { get; set; }
public System.String DeliveryChannel_S3BucketName { get; set; }
public System.String DeliveryChannel_S3KeyPrefix { get; set; }
public System.String DeliveryChannel_S3KmsKeyArn { get; set; }
public System.String DeliveryChannel_SnsTopicARN { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}