security_profile

Gets an individual security_profile resource

Overview

Name	security_profile
Type	Resource
Description	security_profile
Id	awscc.iot.security_profile

Fields

Name	Datatype	Description
security_profile_name	string	A unique identifier for the security profile.
security_profile_description	string	A description of the security profile.
behaviors	array	Specifies the behaviors that, when violated by a device (thing), cause an alert.
alert_targets	object	Specifies the destinations to which alerts are sent.
additional_metrics_to_retain_v2	array	A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
metrics_export_config	object	A structure containing the mqtt topic for metrics export.
tags	array	Metadata that can be used to manage the security profile.
target_arns	array	A set of target ARNs that the security profile is attached to.
security_profile_arn	string	The ARN (Amazon resource name) of the created security profile.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
security_profile_name,
security_profile_description,
behaviors,
alert_targets,
additional_metrics_to_retain_v2,
metrics_export_config,
tags,
target_arns,
security_profile_arn
FROM awscc.iot.security_profile
WHERE data__Identifier = '<SecurityProfileName>';

Permissions

To operate on the security_profile resource, the following permissions are required:

Read

iot:DescribeSecurityProfile,
iot:ListTagsForResource,
iot:ListTargetsForSecurityProfile

Update

iot:UpdateSecurityProfile,
iot:ListTargetsForSecurityProfile,
iot:AttachSecurityProfile,
iot:DetachSecurityProfile,
iot:ListTagsForResource,
iot:UntagResource,
iot:TagResource,
iam:PassRole

Delete

iot:DescribeSecurityProfile,
iot:DeleteSecurityProfile