Class SNSConfig

    • Method Detail

      • getApiURL

        public String getApiURL()
        apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
      • setApiURL

        public void setApiURL​(String apiURL)
        apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
      • getAttributes

        public Map<String,​String> getAttributes()
        attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing.
      • setAttributes

        public void setAttributes​(Map<String,​String> attributes)
        attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing.
      • getHttpConfig

        public HTTPConfig getHttpConfig()
        SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
      • setHttpConfig

        public void setHttpConfig​(HTTPConfig httpConfig)
        SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
      • getMessage

        public String getMessage()
        message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers.
      • setMessage

        public void setMessage​(String message)
        message defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers.
      • getPhoneNumber

        public String getPhoneNumber()
        phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN.
      • setPhoneNumber

        public void setPhoneNumber​(String phoneNumber)
        phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN.
      • getSendResolved

        public Boolean getSendResolved()
        sendResolved defines whether or not to notify about resolved alerts.
      • setSendResolved

        public void setSendResolved​(Boolean sendResolved)
        sendResolved defines whether or not to notify about resolved alerts.
      • getSigv4

        public Sigv4 getSigv4()
        SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
      • setSigv4

        public void setSigv4​(Sigv4 sigv4)
        SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
      • getSubject

        public String getSubject()
        subject defines the subject line when the message is delivered to email endpoints. This field is only used when sending to email subscribers of an SNS topic.
      • setSubject

        public void setSubject​(String subject)
        subject defines the subject line when the message is delivered to email endpoints. This field is only used when sending to email subscribers of an SNS topic.
      • getTargetARN

        public String getTargetARN()
        targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. If you don't specify this value, you must specify a value for the TopicARN or PhoneNumber.
      • setTargetARN

        public void setTargetARN​(String targetARN)
        targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. If you don't specify this value, you must specify a value for the TopicARN or PhoneNumber.
      • getTopicARN

        public String getTopicARN()
        topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.
      • setTopicARN

        public void setTopicARN​(String topicARN)
        topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)