vpc_endpoint_connection_notifications

Creates, updates, deletes or gets a vpc_endpoint_connection_notification resource or lists vpc_endpoint_connection_notifications in a region

Overview

Name	vpc_endpoint_connection_notifications
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Id	awscc.ec2.vpc_endpoint_connection_notifications

Fields

get (all properties)

Name	Datatype	Description
connection_events	array	The endpoint events for which to receive notifications.
vpc_endpoint_id	string	The ID of the endpoint.
vpc_endpoint_connection_notification_id	string	VPC Endpoint Connection ID generated by service
connection_notification_arn	string	The ARN of the SNS topic for the notifications.
service_id	string	The ID of the endpoint service.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
vpc_endpoint_connection_notification_id	string	VPC Endpoint Connection ID generated by service
region	string	AWS region.

For more information, see AWS::EC2::VPCEndpointConnectionNotification.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_endpoint_connection_notifications	INSERT	ConnectionEvents, ConnectionNotificationArn, region
delete_resource	vpc_endpoint_connection_notifications	DELETE	Identifier, region
update_resource	vpc_endpoint_connection_notifications	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_endpoint_connection_notifications_list_only	SELECT	region
get_resource	vpc_endpoint_connection_notifications	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_endpoint_connection_notification.

SELECT
  region,
  connection_events,
  vpc_endpoint_id,
  vpc_endpoint_connection_notification_id,
  connection_notification_arn,
  service_id
FROM awscc.ec2.vpc_endpoint_connection_notifications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vpc_endpoint_connection_notification_id }}';

list (identifiers only)

Lists all vpc_endpoint_connection_notifications in a region.

SELECT
  region,
  vpc_endpoint_connection_notification_id
FROM awscc.ec2.vpc_endpoint_connection_notifications_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new vpc_endpoint_connection_notification resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_endpoint_connection_notifications (
  ConnectionEvents,
  ConnectionNotificationArn,
  region
)
SELECT
  '{{ connection_events }}',
  '{{ connection_notification_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_endpoint_connection_notifications (
  ConnectionEvents,
  VPCEndpointId,
  ConnectionNotificationArn,
  ServiceId,
  region
)
SELECT
  '{{ connection_events }}',
  '{{ vpc_endpoint_id }}',
  '{{ connection_notification_arn }}',
  '{{ service_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: vpc_endpoint_connection_notification
  props:
    - name: connection_events
      value:
        - '{{ connection_events[0] }}'
    - name: vpc_endpoint_id
      value: '{{ vpc_endpoint_id }}'
    - name: connection_notification_arn
      value: '{{ connection_notification_arn }}'
    - name: service_id
      value: '{{ service_id }}'

UPDATE example

Use the following StackQL query and manifest file to update a vpc_endpoint_connection_notification resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.vpc_endpoint_connection_notifications
SET PatchDocument = string('{{ {
    "ConnectionEvents": connection_events,
    "ConnectionNotificationArn": connection_notification_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ vpc_endpoint_connection_notification_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpc_endpoint_connection_notifications
WHERE
  Identifier = '{{ vpc_endpoint_connection_notification_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Read

ec2:DescribeVpcEndpointConnectionNotifications

Create

ec2:CreateVpcEndpointConnectionNotification

Update

ec2:ModifyVpcEndpointConnectionNotification,
ec2:DescribeVpcEndpointConnectionNotifications

List

ec2:DescribeVpcEndpointConnectionNotifications

Delete

ec2:DeleteVpcEndpointConnectionNotifications