Struct aws_sdk_sns::input::CreateTopicInput
source · [−]#[non_exhaustive]pub struct CreateTopicInput {
pub name: Option<String>,
pub attributes: Option<HashMap<String, String>>,
pub tags: Option<Vec<Tag>>,
}Expand description
Input for CreateTopic action.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: Option<String>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.
attributes: Option<HashMap<String, String>>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.
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 totrue, a FIFO topic is created. -
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.
-
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.
Implementations
sourceimpl CreateTopicInput
impl CreateTopicInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTopic, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTopic, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateTopic>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateTopicInput
sourceimpl CreateTopicInput
impl CreateTopicInput
sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
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.
sourcepub fn attributes(&self) -> Option<&HashMap<String, String>>
pub fn attributes(&self) -> Option<&HashMap<String, String>>
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.
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 totrue, a FIFO topic is created. -
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.
-
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.
Trait Implementations
sourceimpl Clone for CreateTopicInput
impl Clone for CreateTopicInput
sourcefn clone(&self) -> CreateTopicInput
fn clone(&self) -> CreateTopicInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for CreateTopicInput
impl Debug for CreateTopicInput
sourceimpl PartialEq<CreateTopicInput> for CreateTopicInput
impl PartialEq<CreateTopicInput> for CreateTopicInput
sourcefn eq(&self, other: &CreateTopicInput) -> bool
fn eq(&self, other: &CreateTopicInput) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &CreateTopicInput) -> bool
fn ne(&self, other: &CreateTopicInput) -> bool
This method tests for !=.
impl StructuralPartialEq for CreateTopicInput
Auto Trait Implementations
impl RefUnwindSafe for CreateTopicInput
impl Send for CreateTopicInput
impl Sync for CreateTopicInput
impl Unpin for CreateTopicInput
impl UnwindSafe for CreateTopicInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more