Product logo
DocsBlogPricing

Control types for @turbot/aws-apigateway

AWS > API Gateway > API > Active

Take an action when an AWS API Gateway api is not active based on the
AWS > API Gateway > API > 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 > API Gateway > API > 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-apigateway#/control/types/apiActive
Parent
Category
Targets

AWS > API Gateway > API > Approved

Take an action when an AWS API Gateway api is not approved based on AWS > API Gateway > API > 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-apigateway#/control/types/apiApproved
Parent
Category
Targets

AWS > API Gateway > API > CMDB

Record and synchronize details for the AWS API Gateway api 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 > API Gateway > API > 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-apigateway#/control/types/apiCmdb
Parent
Category
Targets

AWS > API Gateway > API > Discovery

Discover all AWS API Gateway api 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 > API Gateway > API > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/apiDiscovery
Parent
Category
Targets

AWS > API Gateway > API > Tags

Take an action when an AWS API Gateway api tags is not updated based on the AWS > API Gateway > API > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/apiTags
Parent
Category
Targets

AWS > API Gateway > API > Usage

The Usage control determines whether the number of AWS API Gateway api resources exceeds the configured usage limit for this region.

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

URI
tmod:@turbot/aws-apigateway#/control/types/apiUsage
Parent
Category
Targets

AWS > API Gateway > API Key > Active

Take an action when an AWS API Gateway api key is not active based on the
AWS > API Gateway > API Key > 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 > API Gateway > API Key > 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-apigateway#/control/types/apiKeyActive
Parent
Category
Targets

AWS > API Gateway > API Key > Approved

Take an action when an AWS API Gateway api key is not approved based on AWS > API Gateway > API Key > 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-apigateway#/control/types/apiKeyApproved
Parent
Category
Targets

AWS > API Gateway > API Key > CMDB

Record and synchronize details for the AWS API Gateway api key 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 > API Gateway > API Key > 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-apigateway#/control/types/apiKeyCmdb
Parent
Category
Targets

AWS > API Gateway > API Key > Discovery

Discover all AWS API Gateway api key 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 > API Gateway > API Key > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/apiKeyDiscovery
Parent
Category
Targets

AWS > API Gateway > API Key > Tags

Take an action when an AWS API Gateway api key tags is not updated based on the AWS > API Gateway > API Key > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/apiKeyTags
Parent
Category
Targets

AWS > API Gateway > API Key > Usage

The Usage control determines whether the number of AWS API Gateway api key resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > API Key > Usage policy, and set the limit with the AWS > API Gateway > API Key > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/apiKeyUsage
Parent
Category
Targets

AWS > API Gateway > API V2 > Active

Take an action when an AWS API Gateway api v2 is not active based on the
AWS > API Gateway > API V2 > 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 > API Gateway > API V2 > 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-apigateway#/control/types/apiV2Active
Parent
Category
Targets

AWS > API Gateway > API V2 > Approved

Take an action when an AWS API Gateway api v2 is not approved based on AWS > API Gateway > API V2 > 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-apigateway#/control/types/apiV2Approved
Parent
Category
Targets

AWS > API Gateway > API V2 > CMDB

Record and synchronize details for the AWS API Gateway api v2 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 > API Gateway > API V2 > 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-apigateway#/control/types/apiV2Cmdb
Parent
Category
Targets

AWS > API Gateway > API V2 > Discovery

Discover all AWS API Gateway api v2 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 > API Gateway > API V2 > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/apiV2Discovery
Parent
Category
Targets

AWS > API Gateway > API V2 > Tags

Take an action when an AWS API Gateway api v2 tags is not updated based on the AWS > API Gateway > API V2 > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/apiV2Tags
Parent
Category
Targets

AWS > API Gateway > API V2 > Usage

The Usage control determines whether the number of AWS API Gateway api v2 resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > API V2 > Usage policy, and set the limit with the AWS > API Gateway > API V2 > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/apiV2Usage
Parent
Category
Targets

AWS > API Gateway > Authorizer > Active

Take an action when an AWS API Gateway authorizer is not active based on the
AWS > API Gateway > Authorizer > 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 > API Gateway > Authorizer > 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-apigateway#/control/types/authorizerActive
Parent
Category
Targets

AWS > API Gateway > Authorizer > Approved

Take an action when an AWS API Gateway authorizer is not approved based on AWS > API Gateway > Authorizer > 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-apigateway#/control/types/authorizerApproved
Parent
Category
Targets

AWS > API Gateway > Authorizer > CMDB

Record and synchronize details for the AWS API Gateway authorizer 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 > API Gateway > Authorizer > 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-apigateway#/control/types/authorizerCmdb
Parent
Category
Targets

AWS > API Gateway > Authorizer > Discovery

Discover all AWS API Gateway authorizer 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 > API Gateway > Authorizer > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/authorizerDiscovery
Parent
Category
Targets

AWS > API Gateway > Authorizer > Usage

The Usage control determines whether the number of AWS API Gateway authorizer resources exceeds the configured usage limit for this api.

You can configure the behavior of this control with the AWS > API Gateway > Authorizer > Usage policy, and set the limit with the AWS > API Gateway > Authorizer > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/authorizerUsage
Parent
Category
Targets

AWS > API Gateway > Authorizer V2 > Active

Take an action when an AWS API Gateway authorizer v2 is not active based on the
AWS > API Gateway > Authorizer V2 > 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 > API Gateway > Authorizer V2 > 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-apigateway#/control/types/authorizerV2Active
Parent
Category
Targets

AWS > API Gateway > Authorizer V2 > Approved

Take an action when an AWS API Gateway authorizer v2 is not approved based on AWS > API Gateway > Authorizer V2 > 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-apigateway#/control/types/authorizerV2Approved
Parent
Category
Targets

AWS > API Gateway > Authorizer V2 > CMDB

Record and synchronize details for the AWS API Gateway authorizer v2 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 > API Gateway > Authorizer V2 > 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-apigateway#/control/types/authorizerV2Cmdb
Parent
Category
Targets

AWS > API Gateway > Authorizer V2 > Discovery

Discover all AWS API Gateway authorizer v2 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 > API Gateway > Authorizer V2 > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/authorizerV2Discovery
Parent
Category
Targets

AWS > API Gateway > Authorizer V2 > Usage

The Usage control determines whether the number of AWS API Gateway authorizer v2 resources exceeds the configured usage limit for this apiV2.

You can configure the behavior of this control with the AWS > API Gateway > Authorizer V2 > Usage policy, and set the limit with the AWS > API Gateway > Authorizer V2 > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/authorizerV2Usage
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > Active

Take an action when an AWS API Gateway domain name v2 is not active based on the
AWS > API Gateway > Domain Name V2 > 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 > API Gateway > Domain Name V2 > 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-apigateway#/control/types/domainNameV2Active
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > Approved

Take an action when an AWS API Gateway domain name v2 is not approved based on AWS > API Gateway > Domain Name V2 > 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-apigateway#/control/types/domainNameV2Approved
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > CMDB

Record and synchronize details for the AWS API Gateway domain name v2 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 > API Gateway > Domain Name V2 > 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-apigateway#/control/types/domainNameV2Cmdb
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > Discovery

Discover all AWS API Gateway domain name v2 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 > API Gateway > Domain Name V2 > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/domainNameV2Discovery
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > Tags

Take an action when an AWS API Gateway domain name v2 tags is not updated based on the AWS > API Gateway > Domain Name V2 > Tags > * policies.

If the resource is not updated with the tags defined in AWS > API Gateway > Domain Name V2 > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/domainNameV2Tags
Parent
Category
Targets

AWS > API Gateway > Domain Name V2 > Usage

The Usage control determines whether the number of AWS API Gateway domain name v2 resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > Domain Name V2 > Usage policy, and set the limit with the AWS > API Gateway > Domain Name V2 > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/domainNameV2Usage
Parent
Category
Targets

AWS > API Gateway > Integration V2 > Active

Take an action when an AWS API Gateway integration v2 is not active based on the
AWS > API Gateway > Integration V2 > 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 > API Gateway > Integration V2 > 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-apigateway#/control/types/integrationV2Active
Parent
Category
Targets

AWS > API Gateway > Integration V2 > Approved

Take an action when an AWS API Gateway integration v2 is not approved based on AWS > API Gateway > Integration V2 > 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-apigateway#/control/types/integrationV2Approved
Parent
Category
Targets

AWS > API Gateway > Integration V2 > CMDB

Record and synchronize details for the AWS API Gateway integration v2 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 > API Gateway > Integration V2 > 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-apigateway#/control/types/integrationV2Cmdb
Parent
Category
Targets

AWS > API Gateway > Integration V2 > Discovery

Discover all AWS API Gateway integration v2 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 > API Gateway > Integration V2 > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/integrationV2Discovery
Parent
Category
Targets

AWS > API Gateway > Integration V2 > Usage

The Usage control determines whether the number of AWS API Gateway integration v2 resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > Integration V2 > Usage policy, and set the limit with the AWS > API Gateway > Integration V2 > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/integrationV2Usage
Parent
Category
Targets

AWS > API Gateway > Resource > Active

Take an action when an AWS API Gateway resource is not active based on the
AWS > API Gateway > Resource > 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 > API Gateway > Resource > 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-apigateway#/control/types/apiGatewayResourceActive
Parent
Category
Targets

AWS > API Gateway > Resource > Approved

Take an action when an AWS API Gateway resource is not approved based on AWS > API Gateway > Resource > 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-apigateway#/control/types/apiGatewayResourceApproved
Parent
Category
Targets

AWS > API Gateway > Resource > CMDB

Record and synchronize details for the AWS API Gateway resource 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 > API Gateway > Resource > 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-apigateway#/control/types/apiGatewayResourceCmdb
Parent
Category
Targets

AWS > API Gateway > Resource > Discovery

Discover all AWS API Gateway resource 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 > API Gateway > Resource > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/apiGatewayResourceDiscovery
Parent
Category
Targets

AWS > API Gateway > Resource > Usage

The Usage control determines whether the number of AWS API Gateway resource resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > Resource > Usage policy, and set the limit with the AWS > API Gateway > Resource > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/apiGatewayResourceUsage
Parent
Category
Targets

AWS > API Gateway > Stage > Active

Take an action when an AWS API Gateway stage is not active based on the
AWS > API Gateway > Stage > 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 > API Gateway > Stage > 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-apigateway#/control/types/stageActive
Parent
Category
Targets

AWS > API Gateway > Stage > Approved

Take an action when an AWS API Gateway stage is not approved based on AWS > API Gateway > Stage > 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-apigateway#/control/types/stageApproved
Parent
Category
Targets

AWS > API Gateway > Stage > CMDB

Record and synchronize details for the AWS API Gateway stage 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 > API Gateway > Stage > 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-apigateway#/control/types/stageCmdb
Parent
Category
Targets

AWS > API Gateway > Stage > Discovery

Discover all AWS API Gateway stage 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 > API Gateway > Stage > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/stageDiscovery
Parent
Category
Targets

AWS > API Gateway > Stage > Tags

Take an action when an AWS API Gateway stage tags is not updated based on the AWS > API Gateway > Stage > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/stageTags
Parent
Category
Targets

AWS > API Gateway > Stage > Usage

The Usage control determines whether the number of AWS API Gateway stage resources exceeds the configured usage limit for this api.

You can configure the behavior of this control with the AWS > API Gateway > Stage > Usage policy, and set the limit with the AWS > API Gateway > Stage > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/stageUsage
Parent
Category
Targets

AWS > API Gateway > Stage v2 > Active

Take an action when an AWS API Gateway stage v2 is not active based on the
AWS > API Gateway > Stage v2 > 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 > API Gateway > Stage v2 > 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-apigateway#/control/types/stageV2Active
Parent
Category
Targets

AWS > API Gateway > Stage v2 > Approved

Take an action when an AWS API Gateway stage v2 is not approved based on AWS > API Gateway > Stage v2 > 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-apigateway#/control/types/stageV2Approved
Parent
Category
Targets

AWS > API Gateway > Stage v2 > CMDB

Record and synchronize details for the AWS API Gateway stage v2 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 > API Gateway > Stage v2 > 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-apigateway#/control/types/stageV2Cmdb
Parent
Category
Targets

AWS > API Gateway > Stage v2 > Discovery

Discover all AWS API Gateway stage v2 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 > API Gateway > Stage v2 > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/stageV2Discovery
Parent
Category
Targets

AWS > API Gateway > Stage v2 > Tags

Take an action when an AWS API Gateway stage v2 tags is not updated based on the AWS > API Gateway > Stage v2 > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/stageV2Tags
Parent
Category
Targets

AWS > API Gateway > Stage v2 > Usage

The Usage control determines whether the number of AWS API Gateway stage v2 resources exceeds the configured usage limit for this apiV2.

You can configure the behavior of this control with the AWS > API Gateway > Stage v2 > Usage policy, and set the limit with the AWS > API Gateway > Stage v2 > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/stageV2Usage
Parent
Category
Targets

AWS > API Gateway > Usage Plan > Active

Take an action when an AWS API Gateway usage plan is not active based on the
AWS > API Gateway > Usage Plan > 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 > API Gateway > Usage Plan > 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-apigateway#/control/types/usagePlanActive
Parent
Category
Targets

AWS > API Gateway > Usage Plan > Approved

Take an action when an AWS API Gateway usage plan is not approved based on AWS > API Gateway > Usage Plan > 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-apigateway#/control/types/usagePlanApproved
Parent
Category
Targets

AWS > API Gateway > Usage Plan > CMDB

Record and synchronize details for the AWS API Gateway usage plan 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 > API Gateway > Usage Plan > 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-apigateway#/control/types/usagePlanCmdb
Parent
Category
Targets

AWS > API Gateway > Usage Plan > Discovery

Discover all AWS API Gateway usage plan 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 > API Gateway > Usage Plan > Regions policy, the CMDB control will delete the resource from the CMDB.

URI
tmod:@turbot/aws-apigateway#/control/types/usagePlanDiscovery
Parent
Category
Targets

AWS > API Gateway > Usage Plan > Tags

Take an action when an AWS API Gateway usage plan tags is not updated based on the AWS > API Gateway > Usage Plan > Tags > * policies.

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

See Tags for more information.

URI
tmod:@turbot/aws-apigateway#/control/types/usagePlanTags
Parent
Category
Targets

AWS > API Gateway > Usage Plan > Usage

The Usage control determines whether the number of AWS API Gateway usage plan resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > API Gateway > Usage Plan > Usage policy, and set the limit with the AWS > API Gateway > Usage Plan > Usage > Limit policy.

URI
tmod:@turbot/aws-apigateway#/control/types/usagePlanUsage
Parent
Category
Targets