/*******************************************************************************
* 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.SimpleNotificationService;
using Amazon.SimpleNotificationService.Model;
namespace Amazon.PowerShell.Cmdlets.SNS
{
///
/// Allows a topic owner to set an attribute of the topic to a new value.
///
///
/// To remove the ability to change topic permissions, you must deny permissions to the
/// AddPermission
, RemovePermission
, and SetTopicAttributes
/// actions in your IAM policy.
///
///
[Cmdlet("Set", "SNSTopicAttribute", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Simple Notification Service (SNS) SetTopicAttributes API operation.", Operation = new[] {"SetTopicAttributes"}, SelectReturnType = typeof(Amazon.SimpleNotificationService.Model.SetTopicAttributesResponse))]
[AWSCmdletOutput("None or Amazon.SimpleNotificationService.Model.SetTopicAttributesResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.SimpleNotificationService.Model.SetTopicAttributesResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SetSNSTopicAttributeCmdlet : AmazonSimpleNotificationServiceClientCmdlet, IExecutor
{
#region Parameter AttributeName
///
///
/// A map of attributes with their corresponding values.The following lists the names, descriptions, and values of the special request parameters
/// that the SetTopicAttributes
action uses:ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery
/// status for an Amazon SNS topic that is subscribed to a platform application endpoint.DeliveryPolicy
– The policy that defines how Amazon SNS retries failed
/// deliveries to HTTP/S endpoints.DisplayName
– The display name to use for a topic with SMS subscriptions.Policy
– The policy that defines who can access your topic. By default,
/// only the topic owner can publish or subscribe to the topic.TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
/// is set to PassThrough
, and the topic passes through the tracing header
/// it receives from an Amazon SNS publisher to its subscriptions. If set to Active
,
/// Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag
/// in the tracing header is true. This is only supported on standard topics.- HTTP
HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status
/// for an Amazon SNS topic that is subscribed to an HTTP endpoint. HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages
/// to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status
/// for an Amazon SNS topic that is subscribed to an HTTP endpoint.
- Amazon Kinesis Data Firehose
FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery
/// status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose
/// endpoint.FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful
/// messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis
/// Data Firehose endpoint.FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status
/// for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
///
- Lambda
LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery
/// status for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful
/// messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status
/// for an Amazon SNS topic that is subscribed to an Lambda endpoint.
- Platform application endpoint
ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery
/// status for an Amazon SNS topic that is subscribed to an Amazon Web Services application
/// endpoint.ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful
/// messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services
/// application endpoint.ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery
/// status for an Amazon SNS topic that is subscribed to an Amazon Web Services application
/// endpoint.
In addition to being able to configure topic attributes for message delivery status
/// of notification messages sent to Amazon SNS application endpoints, you can also configure
/// application attributes for the delivery status of push notification messages sent
/// to push notification services.For example, For more information, see Using
/// Amazon SNS Application Attributes for Message Delivery Status. - Amazon SQS
SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status
/// for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages
/// to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. SQSFailureFeedbackRoleArn
– Indicates failed message delivery status
/// for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn
/// attributes are used to give Amazon SNS write access to use CloudWatch Logs on your
/// behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying
/// the sample rate percentage (0-100) of successfully delivered messages. After you configure
/// the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries
/// generate CloudWatch Logs. The following attribute applies only to server-side-encryption:KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master
/// key (CMK) for Amazon SNS or a custom CMK. For more information, see Key
/// Terms. For more examples, see KeyId
/// in the Key Management Service API Reference. SignatureVersion
– The signature version corresponds to the hashing
/// algorithm used while creating the signature of the notifications, subscription confirmations,
/// or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
/// is set to 1
.
The following attribute applies only to FIFO
/// topics:ContentBasedDeduplication
– Enables content-based deduplication for
/// FIFO topics.- By default,
ContentBasedDeduplication
is set to false
. If
/// you create a FIFO topic and this attribute is false
, you must specify
/// a value for the MessageDeduplicationId
parameter for the Publish
/// action. - When you set
ContentBasedDeduplication
to true
, Amazon SNS
/// uses a SHA-256 hash to generate the MessageDeduplicationId
using the
/// body of the message (but not the attributes of the message).(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
/// parameter for the Publish
action.
///
///
#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 AttributeName { get; set; }
#endregion
#region Parameter AttributeValue
///
///
/// The new value for the attribute.
///
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
public System.String AttributeValue { get; set; }
#endregion
#region Parameter TopicArn
///
///
/// The ARN of the topic to modify.
///
///
#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 TopicArn { 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.SimpleNotificationService.Model.SetTopicAttributesResponse).
/// 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 TopicArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^TopicArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TopicArn' 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.TopicArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Set-SNSTopicAttribute (SetTopicAttributes)"))
{
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.TopicArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AttributeName = this.AttributeName;
#if MODULAR
if (this.AttributeName == null && ParameterWasBound(nameof(this.AttributeName)))
{
WriteWarning("You are passing $null as a value for parameter AttributeName 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.AttributeValue = this.AttributeValue;
context.TopicArn = this.TopicArn;
#if MODULAR
if (this.TopicArn == null && ParameterWasBound(nameof(this.TopicArn)))
{
WriteWarning("You are passing $null as a value for parameter TopicArn 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
// 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.SimpleNotificationService.Model.SetTopicAttributesRequest();
if (cmdletContext.AttributeName != null)
{
request.AttributeName = cmdletContext.AttributeName;
}
if (cmdletContext.AttributeValue != null)
{
request.AttributeValue = cmdletContext.AttributeValue;
}
if (cmdletContext.TopicArn != null)
{
request.TopicArn = cmdletContext.TopicArn;
}
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.SimpleNotificationService.Model.SetTopicAttributesResponse CallAWSServiceOperation(IAmazonSimpleNotificationService client, Amazon.SimpleNotificationService.Model.SetTopicAttributesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Notification Service (SNS)", "SetTopicAttributes");
try
{
#if DESKTOP
return client.SetTopicAttributes(request);
#elif CORECLR
return client.SetTopicAttributesAsync(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 AttributeName { get; set; }
public System.String AttributeValue { get; set; }
public System.String TopicArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}