Class SnsAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SnsAction.Builder,
SnsAction>
Describes an action to publish to an Amazon SNS topic.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SnsAction.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final MessageFormat
(Optional) The message format of the message to publish.final String
(Optional) The message format of the message to publish.final String
roleArn()
The ARN of the IAM role that grants access.static Class
<? extends SnsAction.Builder> final String
The ARN of the SNS topic.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
targetArn
The ARN of the SNS topic.
- Returns:
- The ARN of the SNS topic.
-
roleArn
The ARN of the IAM role that grants access.
- Returns:
- The ARN of the IAM role that grants access.
-
messageFormat
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
If the service returns an enum value that is not available in the current SDK version,
messageFormat
will returnMessageFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageFormatAsString()
.- Returns:
- (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws .amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
- See Also:
-
messageFormatAsString
(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
If the service returns an enum value that is not available in the current SDK version,
messageFormat
will returnMessageFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageFormatAsString()
.- Returns:
- (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws .amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SnsAction.Builder,
SnsAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-