notification_hubs

Creates, updates, deletes or gets a notification_hub resource or lists notification_hubs in a region

Overview

Name	notification_hubs
Type	Resource
Description	Resource Type definition for AWS::Notifications::NotificationHub
Id	awscc.notifications.notification_hubs

Fields

get (all properties)

Name	Datatype	Description
region	string	Region that NotificationHub is present in.
▶notification_hub_status_summary	object
creation_time	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
region	string	Region that NotificationHub is present in.
region	string	AWS region.

For more information, see AWS::Notifications::NotificationHub.

Methods

Name	Resource	Accessible by	Required Params
create_resource	notification_hubs	INSERT	Region, region
delete_resource	notification_hubs	DELETE	Identifier, region
list_resources	notification_hubs_list_only	SELECT	region
get_resource	notification_hubs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual notification_hub.

SELECT
  region,
  region,
  notification_hub_status_summary,
  creation_time
FROM awscc.notifications.notification_hubs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ region }}';

list (identifiers only)

Lists all notification_hubs in a region.

SELECT
  region,
  region
FROM awscc.notifications.notification_hubs_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.notifications.notification_hubs (
  Region,
  region
)
SELECT
  '{{ region }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.notifications.notification_hubs (
  Region,
  region
)
SELECT
  '{{ region }}',
  '{{ 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: notification_hub
  props:
    - name: region
      value: '{{ region }}'

DELETE example

/*+ delete */
DELETE FROM awscc.notifications.notification_hubs
WHERE
  Identifier = '{{ region }}' 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 notification_hubs resource, the following permissions are required:

Read

notifications:ListNotificationHubs

Create

notifications:RegisterNotificationHub,
notifications:ListNotificationHubs,
iam:CreateServiceLinkedRole

Delete

notifications:DeregisterNotificationHub,
notifications:ListNotificationHubs

List

notifications:ListNotificationHubs