Class SNSConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SNSConfiguration.Builder,
SNSConfiguration>
Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SNSConfiguration.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 String
roleArn()
The ARN of the IAM role that has access to the target SNS topic.static Class
<? extends SNSConfiguration.Builder> final SnsFormat
The format of the SNS topic.final String
The format of the SNS topic.final String
The ARN of the target 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
-
roleArn
The ARN of the IAM role that has access to the target SNS topic.
- Returns:
- The ARN of the IAM role that has access to the target SNS topic.
-
snsTopicArn
The ARN of the target SNS topic.
- Returns:
- The ARN of the target SNS topic.
-
snsFormat
The format of the SNS topic.
-
JSON
– Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default. -
LONG_TEXT
– Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email. -
SHORT_TEXT
– Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
If the service returns an enum value that is not available in the current SDK version,
snsFormat
will returnSnsFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnsFormatAsString()
.- Returns:
- The format of the SNS topic.
-
JSON
– Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default. -
LONG_TEXT
– Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email. -
SHORT_TEXT
– Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
-
- See Also:
-
-
snsFormatAsString
The format of the SNS topic.
-
JSON
– Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default. -
LONG_TEXT
– Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email. -
SHORT_TEXT
– Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
If the service returns an enum value that is not available in the current SDK version,
snsFormat
will returnSnsFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnsFormatAsString()
.- Returns:
- The format of the SNS topic.
-
JSON
– Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default. -
LONG_TEXT
– Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email. -
SHORT_TEXT
– Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
-
- 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<SNSConfiguration.Builder,
SNSConfiguration> - 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
-