vpc_endpoint_connection_notifications

Creates, updates, deletes, gets or lists a vpc_endpoint_connection_notifications resource.

Overview

Name	vpc_endpoint_connection_notifications
Type	Resource
Id	aws.ec2.vpc_endpoint_connection_notifications

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_connection_notifications

Name	Datatype	Description
connection_events	string	The events for the notification. Valid values are Accept, Connect, Delete, and Reject.
connection_notification_arn	string	The ARN of the SNS topic for the notification.
connection_notification_id	string	The ID of the notification.
connection_notification_state	string	The state of the notification.
connection_notification_type	string	The type of notification.
service_id	string	The ID of the endpoint service.
service_region	string	The Region for the endpoint service.
vpc_endpoint_id	string	The ID of the VPC endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_connection_notifications	select	region	DryRun, ConnectionNotificationId, Filter, MaxResults, NextToken	Describes the connection notifications for VPC endpoints and VPC endpoint services.
create_vpc_endpoint_connection_notification	insert	ConnectionNotificationArn, ConnectionEvents, region	DryRun, ServiceId, VpcEndpointId, ClientToken	Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. You can create a connection notification for interface endpoints only.
modify_vpc_endpoint_connection_notification	update	ConnectionNotificationId, region	DryRun, ConnectionNotificationArn, ConnectionEvents	Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
delete_vpc_endpoint_connection_notifications	delete	ConnectionNotificationId, region	DryRun	Deletes the specified VPC endpoint connection notifications.

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
ConnectionEvents	array	The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
ConnectionNotificationArn	string	The ARN of the SNS topic for the notifications.
ConnectionNotificationId	array	The IDs of the notifications.
region	string	AWS region (default: us-east-1)
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
ConnectionEvents	array	The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.
ConnectionNotificationArn	string	The ARN for the SNS topic for the notification.
ConnectionNotificationId	string	The ID of the notification.
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.
Filter	array	The filters. connection-notification-arn - The ARN of the SNS topic for the notification. connection-notification-id - The ID of the notification. connection-notification-state - The state of the notification (Enabled | Disabled). connection-notification-type - The type of notification (Topic). service-id - The ID of the endpoint service. vpc-endpoint-id - The ID of the VPC endpoint.
MaxResults	integer	The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.
NextToken	string	The token to request the next page of results.
ServiceId	string	The ID of the endpoint service.
VpcEndpointId	string	The ID of the endpoint.

SELECT examples

describe_vpc_endpoint_connection_notifications

Describes the connection notifications for VPC endpoints and VPC endpoint services.

SELECT
connection_events,
connection_notification_arn,
connection_notification_id,
connection_notification_state,
connection_notification_type,
service_id,
service_region,
vpc_endpoint_id
FROM aws.ec2.vpc_endpoint_connection_notifications
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND ConnectionNotificationId = '{{ ConnectionNotificationId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_vpc_endpoint_connection_notification

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. You can create a connection notification for interface endpoints only.

INSERT INTO aws.ec2.vpc_endpoint_connection_notifications (
ConnectionNotificationArn,
ConnectionEvents,
region,
DryRun,
ServiceId,
VpcEndpointId,
ClientToken
)
SELECT 
'{{ ConnectionNotificationArn }}',
'{{ ConnectionEvents }}',
'{{ region }}',
'{{ DryRun }}',
'{{ ServiceId }}',
'{{ VpcEndpointId }}',
'{{ ClientToken }}'
RETURNING
client_token,
connection_notification
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoint_connection_notifications
props:
  - name: ConnectionNotificationArn
    value: "{{ ConnectionNotificationArn }}"
    description: Required parameter for the vpc_endpoint_connection_notifications resource.
  - name: ConnectionEvents
    value: "{{ ConnectionEvents }}"
    description: Required parameter for the vpc_endpoint_connection_notifications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_endpoint_connection_notifications 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.
  - name: ServiceId
    value: "{{ ServiceId }}"
    description: The ID of the endpoint service.
    description: The ID of the endpoint service.
  - name: VpcEndpointId
    value: "{{ VpcEndpointId }}"
    description: The ID of the endpoint.
    description: The ID of the endpoint.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

UPDATE examples

modify_vpc_endpoint_connection_notification

Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.

UPDATE aws.ec2.vpc_endpoint_connection_notifications
SET 
-- No updatable properties
WHERE 
ConnectionNotificationId = '{{ ConnectionNotificationId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND ConnectionNotificationArn = '{{ ConnectionNotificationArn}}'
AND ConnectionEvents = '{{ ConnectionEvents}}'
RETURNING
return_value;

DELETE examples

delete_vpc_endpoint_connection_notifications

Deletes the specified VPC endpoint connection notifications.

DELETE FROM aws.ec2.vpc_endpoint_connection_notifications
WHERE ConnectionNotificationId = '{{ ConnectionNotificationId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;