@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for SetTopicAttributes action.
NOOP
Constructor and Description |
---|
SetTopicAttributesRequest()
Default constructor for SetTopicAttributesRequest object.
|
SetTopicAttributesRequest(String topicArn,
String attributeName,
String attributeValue)
Constructs a new SetTopicAttributesRequest object.
|
Modifier and Type | Method and Description |
---|---|
SetTopicAttributesRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAttributeName()
A map of attributes with their corresponding values.
|
String |
getAttributeValue()
The new value for the attribute.
|
String |
getTopicArn()
The ARN of the topic to modify.
|
int |
hashCode() |
void |
setAttributeName(String attributeName)
A map of attributes with their corresponding values.
|
void |
setAttributeValue(String attributeValue)
The new value for the attribute.
|
void |
setTopicArn(String topicArn)
The ARN of the topic to modify.
|
String |
toString()
Returns a string representation of this object.
|
SetTopicAttributesRequest |
withAttributeName(String attributeName)
A map of attributes with their corresponding values.
|
SetTopicAttributesRequest |
withAttributeValue(String attributeValue)
The new value for the attribute.
|
SetTopicAttributesRequest |
withTopicArn(String topicArn)
The ARN of the topic to modify.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SetTopicAttributesRequest()
public SetTopicAttributesRequest(String topicArn, String attributeName, String attributeValue)
topicArn
- The ARN of the topic to modify.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:
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.
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.
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.
attributeValue
- The new value for the attribute.public void setTopicArn(String topicArn)
The ARN of the topic to modify.
topicArn
- The ARN of the topic to modify.public String getTopicArn()
The ARN of the topic to modify.
public SetTopicAttributesRequest withTopicArn(String topicArn)
The ARN of the topic to modify.
topicArn
- The ARN of the topic to modify.public void setAttributeName(String 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:
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.
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.
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.
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:
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.
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.
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.
public String getAttributeName()
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.
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.
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.
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.
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.
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.
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.
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.
public SetTopicAttributesRequest withAttributeName(String 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:
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.
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.
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.
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:
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.
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.
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.
public void setAttributeValue(String attributeValue)
The new value for the attribute.
attributeValue
- The new value for the attribute.public String getAttributeValue()
The new value for the attribute.
public SetTopicAttributesRequest withAttributeValue(String attributeValue)
The new value for the attribute.
attributeValue
- The new value for the attribute.public String toString()
toString
in class Object
Object.toString()
public SetTopicAttributesRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2023. All rights reserved.