AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SNS::Model::SetTopicAttributesRequest Class Reference

#include <SetTopicAttributesRequest.h>

+ Inheritance diagram for Aws::SNS::Model::SetTopicAttributesRequest:

Public Member Functions

 SetTopicAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetTopicArn () const
 
bool TopicArnHasBeenSet () const
 
void SetTopicArn (const Aws::String &value)
 
void SetTopicArn (Aws::String &&value)
 
void SetTopicArn (const char *value)
 
SetTopicAttributesRequestWithTopicArn (const Aws::String &value)
 
SetTopicAttributesRequestWithTopicArn (Aws::String &&value)
 
SetTopicAttributesRequestWithTopicArn (const char *value)
 
const Aws::StringGetAttributeName () const
 
bool AttributeNameHasBeenSet () const
 
void SetAttributeName (const Aws::String &value)
 
void SetAttributeName (Aws::String &&value)
 
void SetAttributeName (const char *value)
 
SetTopicAttributesRequestWithAttributeName (const Aws::String &value)
 
SetTopicAttributesRequestWithAttributeName (Aws::String &&value)
 
SetTopicAttributesRequestWithAttributeName (const char *value)
 
const Aws::StringGetAttributeValue () const
 
bool AttributeValueHasBeenSet () const
 
void SetAttributeValue (const Aws::String &value)
 
void SetAttributeValue (Aws::String &&value)
 
void SetAttributeValue (const char *value)
 
SetTopicAttributesRequestWithAttributeValue (const Aws::String &value)
 
SetTopicAttributesRequestWithAttributeValue (Aws::String &&value)
 
SetTopicAttributesRequestWithAttributeValue (const char *value)
 
- Public Member Functions inherited from Aws::SNS::SNSRequest
virtual ~SNSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SNS::SNSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Input for SetTopicAttributes action.

See Also:

AWS API Reference

Definition at line 24 of file SetTopicAttributesRequest.h.

Constructor & Destructor Documentation

◆ SetTopicAttributesRequest()

Aws::SNS::Model::SetTopicAttributesRequest::SetTopicAttributesRequest ( )

Member Function Documentation

◆ AttributeNameHasBeenSet()

bool Aws::SNS::Model::SetTopicAttributesRequest::AttributeNameHasBeenSet ( ) const
inline

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:

  • 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.

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.

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.

Definition at line 153 of file SetTopicAttributesRequest.h.

◆ AttributeValueHasBeenSet()

bool Aws::SNS::Model::SetTopicAttributesRequest::AttributeValueHasBeenSet ( ) const
inline

The new value for the attribute.

Definition at line 380 of file SetTopicAttributesRequest.h.

◆ DumpBodyToUrl()

void Aws::SNS::Model::SetTopicAttributesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAttributeName()

const Aws::String& Aws::SNS::Model::SetTopicAttributesRequest::GetAttributeName ( ) const
inline

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:

  • 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.

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.

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.

Definition at line 117 of file SetTopicAttributesRequest.h.

◆ GetAttributeValue()

const Aws::String& Aws::SNS::Model::SetTopicAttributesRequest::GetAttributeValue ( ) const
inline

The new value for the attribute.

Definition at line 375 of file SetTopicAttributesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SNS::Model::SetTopicAttributesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SetTopicAttributesRequest.h.

◆ GetTopicArn()

const Aws::String& Aws::SNS::Model::SetTopicAttributesRequest::GetTopicArn ( ) const
inline

The ARN of the topic to modify.

Definition at line 45 of file SetTopicAttributesRequest.h.

◆ SerializePayload()

Aws::String Aws::SNS::Model::SetTopicAttributesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeName() [1/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeName ( Aws::String &&  value)
inline

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:

  • 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.

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.

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.

Definition at line 225 of file SetTopicAttributesRequest.h.

◆ SetAttributeName() [2/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeName ( const Aws::String value)
inline

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:

  • 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.

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.

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.

Definition at line 189 of file SetTopicAttributesRequest.h.

◆ SetAttributeName() [3/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeName ( const char *  value)
inline

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:

  • 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.

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.

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.

Definition at line 261 of file SetTopicAttributesRequest.h.

◆ SetAttributeValue() [1/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeValue ( Aws::String &&  value)
inline

The new value for the attribute.

Definition at line 390 of file SetTopicAttributesRequest.h.

◆ SetAttributeValue() [2/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeValue ( const Aws::String value)
inline

The new value for the attribute.

Definition at line 385 of file SetTopicAttributesRequest.h.

◆ SetAttributeValue() [3/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetAttributeValue ( const char *  value)
inline

The new value for the attribute.

Definition at line 395 of file SetTopicAttributesRequest.h.

◆ SetTopicArn() [1/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetTopicArn ( Aws::String &&  value)
inline

The ARN of the topic to modify.

Definition at line 60 of file SetTopicAttributesRequest.h.

◆ SetTopicArn() [2/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetTopicArn ( const Aws::String value)
inline

The ARN of the topic to modify.

Definition at line 55 of file SetTopicAttributesRequest.h.

◆ SetTopicArn() [3/3]

void Aws::SNS::Model::SetTopicAttributesRequest::SetTopicArn ( const char *  value)
inline

The ARN of the topic to modify.

Definition at line 65 of file SetTopicAttributesRequest.h.

◆ TopicArnHasBeenSet()

bool Aws::SNS::Model::SetTopicAttributesRequest::TopicArnHasBeenSet ( ) const
inline

The ARN of the topic to modify.

Definition at line 50 of file SetTopicAttributesRequest.h.

◆ WithAttributeName() [1/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeName ( Aws::String &&  value)
inline

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:

  • 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.

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.

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.

Definition at line 333 of file SetTopicAttributesRequest.h.

◆ WithAttributeName() [2/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeName ( const Aws::String value)
inline

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:

  • 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.

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.

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.

Definition at line 297 of file SetTopicAttributesRequest.h.

◆ WithAttributeName() [3/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeName ( const char *  value)
inline

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:

  • 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.

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.

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.

Definition at line 369 of file SetTopicAttributesRequest.h.

◆ WithAttributeValue() [1/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeValue ( Aws::String &&  value)
inline

The new value for the attribute.

Definition at line 405 of file SetTopicAttributesRequest.h.

◆ WithAttributeValue() [2/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeValue ( const Aws::String value)
inline

The new value for the attribute.

Definition at line 400 of file SetTopicAttributesRequest.h.

◆ WithAttributeValue() [3/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithAttributeValue ( const char *  value)
inline

The new value for the attribute.

Definition at line 410 of file SetTopicAttributesRequest.h.

◆ WithTopicArn() [1/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithTopicArn ( Aws::String &&  value)
inline

The ARN of the topic to modify.

Definition at line 75 of file SetTopicAttributesRequest.h.

◆ WithTopicArn() [2/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithTopicArn ( const Aws::String value)
inline

The ARN of the topic to modify.

Definition at line 70 of file SetTopicAttributesRequest.h.

◆ WithTopicArn() [3/3]

SetTopicAttributesRequest& Aws::SNS::Model::SetTopicAttributesRequest::WithTopicArn ( const char *  value)
inline

The ARN of the topic to modify.

Definition at line 80 of file SetTopicAttributesRequest.h.


The documentation for this class was generated from the following file: