Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LookoutMetrics.Types.SNSConfiguration

Description

Synopsis

Documentation

data SNSConfiguration Source #

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: newSNSConfiguration smart constructor.

Constructors

SNSConfiguration'

Fields

snsFormat :: Maybe 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.
roleArn :: Text
The ARN of the IAM role that has access to the target SNS topic.
snsTopicArn :: Text
The ARN of the target SNS topic.

Instances

Instances details

FromJSON SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods parseJSON :: Value -> Parser SNSConfiguration # parseJSONList :: Value -> Parser [SNSConfiguration] #
ToJSON SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods toJSON :: SNSConfiguration -> Value # toEncoding :: SNSConfiguration -> Encoding # toJSONList :: [SNSConfiguration] -> Value # toEncodingList :: [SNSConfiguration] -> Encoding #
Generic SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Associated Types type Rep SNSConfiguration :: Type -> Type # Methods from :: SNSConfiguration -> Rep SNSConfiguration x # to :: Rep SNSConfiguration x -> SNSConfiguration #
Read SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods readsPrec :: Int -> ReadS SNSConfiguration # readList :: ReadS [SNSConfiguration] # readPrec :: ReadPrec SNSConfiguration # readListPrec :: ReadPrec [SNSConfiguration] #
Show SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods showsPrec :: Int -> SNSConfiguration -> ShowS # show :: SNSConfiguration -> String # showList :: [SNSConfiguration] -> ShowS #
NFData SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods rnf :: SNSConfiguration -> () #
Eq SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods (==) :: SNSConfiguration -> SNSConfiguration -> Bool # (/=) :: SNSConfiguration -> SNSConfiguration -> Bool #
Hashable SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration Methods hashWithSalt :: Int -> SNSConfiguration -> Int # hash :: SNSConfiguration -> Int #
type Rep SNSConfiguration Source #
Instance details Defined in Amazonka.LookoutMetrics.Types.SNSConfiguration type Rep SNSConfiguration = D1 ('MetaData "SNSConfiguration" "Amazonka.LookoutMetrics.Types.SNSConfiguration" "amazonka-lookoutmetrics-2.0-5gJoMWEA4GrGsqHAPh1b9h" 'False) (C1 ('MetaCons "SNSConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "snsFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnsFormat)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSNSConfiguration Source #

Arguments

:: Text	`$sel:roleArn:SNSConfiguration'`
-> Text	`$sel:snsTopicArn:SNSConfiguration'`
-> SNSConfiguration

Create a value of SNSConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:snsFormat:SNSConfiguration', sNSConfiguration_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.

$sel:roleArn:SNSConfiguration', sNSConfiguration_roleArn - The ARN of the IAM role that has access to the target SNS topic.

$sel:snsTopicArn:SNSConfiguration', sNSConfiguration_snsTopicArn - The ARN of the target SNS topic.

sNSConfiguration_snsFormat :: Lens' SNSConfiguration (Maybe SnsFormat) Source #

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.

sNSConfiguration_roleArn :: Lens' SNSConfiguration Text Source #

The ARN of the IAM role that has access to the target SNS topic.

sNSConfiguration_snsTopicArn :: Lens' SNSConfiguration Text Source #

The ARN of the target SNS topic.