Class SNSConfig
- java.lang.Object
-
- io.fabric8.openshift.api.model.monitoring.v1beta1.SNSConfig
-
- All Implemented Interfaces:
Editable<SNSConfigBuilder>,KubernetesResource,Serializable
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator") public class SNSConfig extends Object implements Editable<SNSConfigBuilder>, KubernetesResource
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SNSConfig()No args constructor for use in serializationSNSConfig(String apiURL, Map<String,String> attributes, HTTPConfig httpConfig, String message, String phoneNumber, Boolean sendResolved, Sigv4 sigv4, String subject, String targetARN, String topicARN)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SNSConfigBuilderedit()Map<String,Object>getAdditionalProperties()StringgetApiURL()apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.Map<String,String>getAttributes()attributes defines SNS message attributes as key-value pairs.HTTPConfiggetHttpConfig()SNSConfig configures notifications via AWS SNS.StringgetMessage()message defines the message content of the SNS notification.StringgetPhoneNumber()phoneNumber defines the phone number if message is delivered via SMS in E.164 format.BooleangetSendResolved()sendResolved defines whether or not to notify about resolved alerts.Sigv4getSigv4()SNSConfig configures notifications via AWS SNS.StringgetSubject()subject defines the subject line when the message is delivered to email endpoints.StringgetTargetARN()targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.StringgetTopicARN()topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.voidsetAdditionalProperties(Map<String,Object> additionalProperties)voidsetAdditionalProperty(String name, Object value)voidsetApiURL(String apiURL)apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.voidsetAttributes(Map<String,String> attributes)attributes defines SNS message attributes as key-value pairs.voidsetHttpConfig(HTTPConfig httpConfig)SNSConfig configures notifications via AWS SNS.voidsetMessage(String message)message defines the message content of the SNS notification.voidsetPhoneNumber(String phoneNumber)phoneNumber defines the phone number if message is delivered via SMS in E.164 format.voidsetSendResolved(Boolean sendResolved)sendResolved defines whether or not to notify about resolved alerts.voidsetSigv4(Sigv4 sigv4)SNSConfig configures notifications via AWS SNS.voidsetSubject(String subject)subject defines the subject line when the message is delivered to email endpoints.voidsetTargetARN(String targetARN)targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.voidsetTopicARN(String topicARN)topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.SNSConfigBuildertoBuilder()
-
-
-
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.
-
edit
public SNSConfigBuilder edit()
- Specified by:
editin interfaceEditable<SNSConfigBuilder>
-
toBuilder
public SNSConfigBuilder toBuilder()
-
-