instance_event_notification_attributes
Creates, updates, deletes, gets or lists an instance_event_notification_attributes resource.
Overview
| Name | instance_event_notification_attributes |
| Type | Resource |
| Id | aws.ec2.instance_event_notification_attributes |
Fields
The following fields are returned by SELECT queries:
- describe_instance_event_notification_attributes
| Name | Datatype | Description |
|---|---|---|
include_all_tags_of_instance | boolean | Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered. |
instance_tag_keys | string | The registered tag keys. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_instance_event_notification_attributes | select | region | DryRun | Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. |
register_instance_event_notification_attributes | insert | InstanceTagAttribute, region | DryRun | Registers a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use DeregisterInstanceEventNotificationAttributes. |
deregister_instance_event_notification_attributes | delete | InstanceTagAttribute, region | DryRun | Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
InstanceTagAttribute | object | Information about the tag keys to deregister. |
region | string | AWS region (default: us-east-1) |
DryRun | boolean | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. |
SELECT examples
- describe_instance_event_notification_attributes
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
SELECT
include_all_tags_of_instance,
instance_tag_keys
FROM aws.ec2.instance_event_notification_attributes
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;
INSERT examples
- register_instance_event_notification_attributes
- Manifest
Registers a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use DeregisterInstanceEventNotificationAttributes.
INSERT INTO aws.ec2.instance_event_notification_attributes (
InstanceTagAttribute,
region,
DryRun
)
SELECT
'{{ InstanceTagAttribute }}',
'{{ region }}',
'{{ DryRun }}'
RETURNING
include_all_tags_of_instance,
instance_tag_keys
;
# Description fields are for documentation purposes
- name: instance_event_notification_attributes
props:
- name: InstanceTagAttribute
value: "{{ InstanceTagAttribute }}"
description: Required parameter for the instance_event_notification_attributes resource.
- name: region
value: "{{ region }}"
description: Required parameter for the instance_event_notification_attributes resource.
- name: DryRun
value: {{ DryRun }}
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
DELETE examples
- deregister_instance_event_notification_attributes
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
DELETE FROM aws.ec2.instance_event_notification_attributes
WHERE InstanceTagAttribute = '{{ InstanceTagAttribute }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;