Control types for @turbot/aws-sns

AWS > SNS > Subscription > Active

Take an action when an AWS SNS subscription is not active based on the
AWS > SNS > Subscription > Active > * policies.

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > SNS > Subscription > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.

Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sns#/control/types/subscriptionActive

AWS > SNS > Subscription > Approved

Take an action when an AWS SNS subscription is not approved based on AWS > SNS > Subscription > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

URI
tmod:@turbot/aws-sns#/control/types/subscriptionApproved

AWS > SNS > Subscription > CMDB

Record and synchronize details for the AWS SNS subscription into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > SNS > Subscription > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

URI
tmod:@turbot/aws-sns#/control/types/subscriptionCmdb
Category

AWS > SNS > Subscription > Configured

Maintain AWS > SNS > Subscription configuration.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it.

URI
tmod:@turbot/aws-sns#/control/types/subscriptionConfigured

AWS > SNS > Subscription > Discovery

Discover all AWS SNS subscription resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > SNS > Subscription > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-sns#/control/types/subscriptionDiscovery

AWS > SNS > Subscription > Usage

The Usage control determines whether the number of AWS SNS subscription resources exceeds the configured usage limit for this account.

You can configure the behavior of this control with the AWS > SNS > Subscription > Usage policy, and set the limit with the AWS > SNS > Subscription > Usage > Limit policy.

URI
tmod:@turbot/aws-sns#/control/types/subscriptionUsage

AWS > SNS > Topic > Active

Take an action when an AWS SNS topic is not active based on the
AWS > SNS > Topic > Active > * policies.

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > SNS > Topic > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.

Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sns#/control/types/topicActive

AWS > SNS > Topic > Approved

Take an action when an AWS SNS topic is not approved based on AWS > SNS > Topic > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

URI
tmod:@turbot/aws-sns#/control/types/topicApproved

AWS > SNS > Topic > CMDB

Record and synchronize details for the AWS SNS topic into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > SNS > Topic > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

URI
tmod:@turbot/aws-sns#/control/types/topicCmdb
Category

AWS > SNS > Topic > Configured

Maintain AWS > SNS > Topic configuration.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it.

URI
tmod:@turbot/aws-sns#/control/types/topicConfigured

AWS > SNS > Topic > Discovery

Discover all AWS SNS topic resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > SNS > Topic > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-sns#/control/types/topicDiscovery

AWS > SNS > Topic > Encryption at Rest

Define the Encryption at Rest settings required for AWS > SNS > Topic.

Encryption at Rest refers specifically to the encryption of data when written
to an underlying storage system. This control determines whether the resource
is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest
control compares the encryption settings against the encryption policies for the resource
(AWS > SNS > Topic > Encryption at Rest > *),
raises an alarm, and takes the defined enforcement action.

URI
tmod:@turbot/aws-sns#/control/types/topicEncryptionAtRest

AWS > SNS > Topic > Policy

URI
tmod:@turbot/aws-sns#/control/types/topicPolicy

AWS > SNS > Topic > Policy > Trusted Access

Take an action when AWS SNS topic policy is not trusted based on the
AWS > SNS > Topic > Policy > Trusted Access > * policies.

The Trusted Access control evaluates the topic policy against the list of allowed
members in each of the Trusted Access sub-policies (Trusted Access > Accounts,
Trusted Access > Services etc.), this control raises an alarm and takes the
defined enforcement action.

The account that owns the topic will always be trusted, even if its account ID is
not included in the Trusted Accounts policy.

If set to Enforce: Revoke untrusted access, access to non-trusted
members will be removed.

URI
tmod:@turbot/aws-sns#/control/types/topicPolicyTrustedAccess

AWS > SNS > Topic > Tags

Take an action when an AWS SNS topic tags is not updated based on the AWS > SNS > Topic > Tags > * policies.

If the resource is not updated with the tags defined in AWS > SNS > Topic > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

URI
tmod:@turbot/aws-sns#/control/types/topicTags

AWS > SNS > Topic > Usage

The Usage control determines whether the number of AWS SNS topic resources exceeds the configured usage limit for this account.

You can configure the behavior of this control with the AWS > SNS > Topic > Usage policy, and set the limit with the AWS > SNS > Topic > Usage > Limit policy.

URI
tmod:@turbot/aws-sns#/control/types/topicUsage

AWS > SNS > Topic Policy > CMDB

Record and synchronize details for the AWS SNS topic policy into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

URI
tmod:@turbot/aws-sns#/control/types/topicPolicyCmdb
Category

AWS > SNS > Topic Policy > Configured

Maintain AWS > SNS > Topic Policy configuration.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it.

URI
tmod:@turbot/aws-sns#/control/types/topicPolicyConfigured

AWS > SNS > Topic Policy > Discovery

Discover all AWS SNS topic policy resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

URI
tmod:@turbot/aws-sns#/control/types/topicPolicyDiscovery