General
Manage connectors for sending notifications to customer-configured destinations.A notification connector specifies where Trend Micro Cloud OneTM – Network Security should send messages to alert a user about specific conditions.
A notification type specifies the type of messages to send to a connector. For example, an "appliancehealth" notification type specifies messages related to the status of Network Security virtual appliances.
A connector type specifies the service specific to a cloud service provider to use for notifications for a connector. For example, an snsconnector type indicates the Amazon Simple Notification Service (SNS).
Amazon SNS
Follow these steps to ensure that Network Security can send notifications to your Amazon SNS topic.Role
Create a role (or modify an existing role) in your account that Network Security can assume to publish messages to your SNS topic. Ensure the role has permission to publish messages.{ "Version": "2012-10-17", "Statement": [ { "Sid": "SnsPublish", "Effect": "Allow", "Action": [ "SNS:Publish" ], "Resource": "arn:aws:sns:us-west-1:123456789012:MyTopic" } ] }Replace the resource ARN above with the ARN for your SNS topic. Also, ensure the role has a trust policy that allows Network Security to assume the role.
{ "Version": "2012-10-17", "Statement": [ { "Sid": "NetworkSecurityAssumeRole", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::737318609257:root" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "12345abc" } } } ] }Please note that the account ID in the principal ARN is the Network Security AWS account ID. Replace the STS external ID with the same value you use to create a connector. This should be a non-trivial random value known only to you.
Topic Access Policy
The SNS topic used by Network Security should allow the role above to publish messages.{ "Sid": "NetworkSecurityPublish", "Effect": "Allow", "Principal": { "AWS": "arn:aws:sts::123456789012:assumed-role/MyRole/<Notification Type>" }, "Action": "SNS:Publish", "Resource": "arn:aws:sns:us-west-1:123456789012:MyTopic" }Replace the account ID and role name in the principal ARN with the values for the role created above. The <Notification Type> in the principal ARN should match the notification type used in the corresponding notification connector. For example, "appliancehealth".
List SNS connectors
Retrieve a list of all SNS connectors. If no SNS connectors are defined, this request will return an empty list. Please note that the list of items in the response are encapsulated as the value of a top-level connectors
key.
Successfully retrieved the list of SNS connectors
Unauthorized
Forbidden
Internal server error
- 200
- 500
{- "connectors": [
- {
- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
]
}
Create SNS connector
Create a new SNS connector from the body of the request.
Request Body schema: application/json
The SNS connector to create.
Successfully created SNS connector
Unauthorized
Forbidden
SNS connector already exists
Invalid SNS connector
Internal server error
- Payload
{- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
- 201
- 409
- 422
- 500
{- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
Describe SNS connector
Retrieve the SNS connector details for the specified notification type.
Successfully retrieved the SNS connector
Unauthorized
Forbidden
SNS connector not found
Internal server error
- 200
- 500
{- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
Update SNS connector
Update an existing SNS connector with the values from the body of the request.
Request Body schema: application/json
The SNS connector to update.
Successfully updated the SNS connector
Unauthorized
Forbidden
SNS connector not found
Invalid SNS connector
Internal server error
- Payload
{- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
- 200
- 422
- 500
{- "notificationType": "appliancehealth",
- "topicArn": "arn:aws:sns:us-west-1:123456789012:nsva-health",
- "roleArn": "arn:aws:iam::123456789012:role/SnsNotificationRole",
- "externalId": "41819d20-b9a1-11eb-94c9-c769b191f4cc"
}
Delete SNS connector
Delete the SNS connector for the specified notification type.
Successfully deleted the SNS connector
Unauthorized
Forbidden
SNS connector not found
Internal server error
- 500
{- "message": "Internal server error"
}
Send a test notification
Send a test notification to verify the specified SNS connector settings.
Successfully sent test SNS notification
Unauthorized
Forbidden
SNS connector not found
Internal server error
- 500
{- "message": "Internal server error"
}