@Generated(value="software.amazon.awssdk:codegen") public final class CreateTopicRequest extends SnsRequest implements ToCopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
Input for CreateTopic action.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateTopicRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
attributes()
A map of attributes with their corresponding values.
|
static CreateTopicRequest.Builder |
builder() |
String |
dataProtectionPolicy()
The body of the policy document you want to use for this topic.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
name()
The name of the topic you want to create.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateTopicRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The list of tags to add to a new topic.
|
CreateTopicRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String name()
The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo
suffix.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
For a FIFO (first-in-first-out) topic, the name must end with the .fifo
suffix.
public final boolean hasAttributes()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,String> attributes()
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
CreateTopic
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.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can
publish or subscribe to the topic.
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.
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.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAttributes()
method.
The following lists the names, descriptions, and values of the special request parameters that the
CreateTopic
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.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner
can publish or subscribe to the topic.
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.
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.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
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 final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
The list of tags to add to a new topic.
To be able to tag a topic on creation, you must have the sns:CreateTopic
and
sns:TagResource
permissions.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
To be able to tag a topic on creation, you must have the sns:CreateTopic
and
sns:TagResource
permissions.
public final String dataProtectionPolicy()
The body of the policy document you want to use for this topic.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
You can only add one policy per topic.
The policy must be in JSON string format.
Length Constraints: Maximum length of 30,720.
public CreateTopicRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
toBuilder
in class SnsRequest
public static CreateTopicRequest.Builder builder()
public static Class<? extends CreateTopicRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.