Interface CreateTopicRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>,SdkBuilder<CreateTopicRequest.Builder,CreateTopicRequest>,SdkPojo,SdkRequest.Builder,SnsRequest.Builder
- Enclosing class:
- CreateTopicRequest
@Mutable @NotThreadSafe public static interface CreateTopicRequest.Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder<CreateTopicRequest.Builder,CreateTopicRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateTopicRequest.Builderattributes(Map<String,String> attributes)A map of attributes with their corresponding values.CreateTopicRequest.BuilderdataProtectionPolicy(String dataProtectionPolicy)The body of the policy document you want to use for this topic.CreateTopicRequest.Buildername(String name)The name of the topic you want to create.CreateTopicRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateTopicRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateTopicRequest.Buildertags(Collection<Tag> tags)The list of tags to add to a new topic.CreateTopicRequest.Buildertags(Consumer<Tag.Builder>... tags)The list of tags to add to a new topic.CreateTopicRequest.Buildertags(Tag... tags)The list of tags to add to a new topic.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.sns.model.SnsRequest.Builder
build
-
-
-
-
Method Detail
-
name
CreateTopicRequest.Builder name(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
.fifosuffix.- Parameters:
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
.fifosuffix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
CreateTopicRequest.Builder attributes(Map<String,String> attributes)
A map of attributes with their corresponding values.
The following lists names, descriptions, and values of the special request parameters that the
CreateTopicaction 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 defaultTracingConfigis set toPassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set toActive, 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 Data Firehose
-
FirehoseSuccessFeedbackRoleArn– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. -
FirehoseSuccessFeedbackSampleRate– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. -
FirehoseFailureFeedbackRoleArn– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon 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 a platform application endpoint. -
ApplicationSuccessFeedbackSampleRate– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint. -
ApplicationFailureFeedbackRoleArn– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform 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.
The following attributes apply only to FIFO topics:
-
ArchivePolicy– The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. -
ContentBasedDeduplication– Enables content-based deduplication for FIFO topics.-
By default,
ContentBasedDeduplicationis set tofalse. If you create a FIFO topic and this attribute isfalse, you must specify a value for theMessageDeduplicationIdparameter for the Publish action. -
When you set
ContentBasedDeduplicationtotrue, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationIdusing 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
MessageDeduplicationIdparameter for thePublishaction.
-
-
FifoThroughputScope– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:-
Topic– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. -
MessageGroup– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
-
- Parameters:
attributes- A map of attributes with their corresponding values.The following lists names, descriptions, and values of the special request parameters that the
CreateTopicaction 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 defaultTracingConfigis set toPassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set toActive, 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 Data Firehose
-
FirehoseSuccessFeedbackRoleArn– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. -
FirehoseSuccessFeedbackSampleRate– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Data Firehose endpoint. -
FirehoseFailureFeedbackRoleArn– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon 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 a platform application endpoint. -
ApplicationSuccessFeedbackSampleRate– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an platform application endpoint. -
ApplicationFailureFeedbackRoleArn– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an platform 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.
The following attributes apply only to FIFO topics:
-
ArchivePolicy– The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic. -
ContentBasedDeduplication– Enables content-based deduplication for FIFO topics.-
By default,
ContentBasedDeduplicationis set tofalse. If you create a FIFO topic and this attribute isfalse, you must specify a value for theMessageDeduplicationIdparameter for the Publish action. -
When you set
ContentBasedDeduplicationtotrue, Amazon SNS uses a SHA-256 hash to generate theMessageDeduplicationIdusing 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
MessageDeduplicationIdparameter for thePublishaction.
-
-
FifoThroughputScope– Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:-
Topic– The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first. -
MessageGroup– The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
CreateTopicRequest.Builder tags(Collection<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:CreateTopicandsns:TagResourcepermissions.- Parameters:
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:CreateTopicandsns:TagResourcepermissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateTopicRequest.Builder tags(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:CreateTopicandsns:TagResourcepermissions.- Parameters:
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:CreateTopicandsns:TagResourcepermissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateTopicRequest.Builder tags(Consumer<Tag.Builder>... tags)
The list of tags to add to a new topic.
This is a convenience method that creates an instance of theTo be able to tag a topic on creation, you must have the
sns:CreateTopicandsns:TagResourcepermissions.Tag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
dataProtectionPolicy
CreateTopicRequest.Builder dataProtectionPolicy(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateTopicRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateTopicRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-