Package software.amazon.awssdk.services.lookoutmetrics.model

Class SNSConfiguration

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.SNSConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SNSConfiguration.Builder,SNSConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class SNSConfiguration
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SNSConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SNSConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The ARN of the IAM role that has access to the target SNS topic.
List<SdkField<?>>	sdkFields()
static Class<? extends SNSConfiguration.Builder>	serializableBuilderClass()
SnsFormat	snsFormat()	The format of the SNS topic.
String	snsFormatAsString()	The format of the SNS topic.
String	snsTopicArn()	The ARN of the target SNS topic.
SNSConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleArn

public final String 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

public final String snsTopicArn()

The ARN of the target SNS topic.

Returns:

The ARN of the target SNS topic.

snsFormat

public final SnsFormat 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 return SnsFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snsFormatAsString().

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:

SnsFormat

snsFormatAsString

public final String 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 return SnsFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snsFormatAsString().

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:

SnsFormat

toBuilder

public SNSConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SNSConfiguration.Builder,SNSConfiguration>

builder

public static SNSConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SNSConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo