discoverers

Creates, updates, deletes or gets a discoverer resource or lists discoverers in a region

Overview

Name	discoverers
Type	Resource
Description	Resource Type definition for AWS::EventSchemas::Discoverer
Id	aws.eventschemas.discoverers

Fields

Name	Datatype	Description
discoverer_arn	string	The ARN of the discoverer.
discoverer_id	string	The Id of the discoverer.
description	string	A description for the discoverer.
source_arn	string	The ARN of the event bus.
cross_account	boolean	Defines whether event schemas from other accounts are discovered. Default is True.
state	string	Defines the current state of the discoverer.
tags	array	Tags associated with the resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SourceArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all discoverers in a region.

SELECT
region,
discoverer_arn,
discoverer_id,
description,
source_arn,
cross_account,
state,
tags
FROM aws.eventschemas.discoverers
WHERE region = 'us-east-1';

Gets all properties from an individual discoverer.

SELECT
region,
discoverer_arn,
discoverer_id,
description,
source_arn,
cross_account,
state,
tags
FROM aws.eventschemas.discoverers
WHERE region = 'us-east-1' AND data__Identifier = '<DiscovererArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.eventschemas.discoverers (
 SourceArn,
 region
)
SELECT 
'{{ SourceArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.eventschemas.discoverers (
 Description,
 SourceArn,
 CrossAccount,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ SourceArn }}',
 '{{ CrossAccount }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: discoverer
    props:
      - name: Description
        value: '{{ Description }}'
      - name: SourceArn
        value: '{{ SourceArn }}'
      - name: CrossAccount
        value: '{{ CrossAccount }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.eventschemas.discoverers
WHERE data__Identifier = '<DiscovererArn>'
AND region = 'us-east-1';

Permissions

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

Create

schemas:CreateDiscoverer,
schemas:DescribeDiscoverer,
schemas:TagResource,
events:PutRule,
events:PutTargets,
events:EnableRule,
events:ListTargetsByRule,
iam:CreateServiceLinkedRole

Read

schemas:DescribeDiscoverer

Update

schemas:DescribeDiscoverer,
schemas:UpdateDiscoverer,
schemas:TagResource,
schemas:UntagResource,
schemas:ListTagsForResource,
events:PutTargets,
events:PutRule

Delete

schemas:DescribeDiscoverer,
schemas:DeleteDiscoverer,
events:DeleteRule,
events:DisableRule,
events:RemoveTargets

List

schemas:ListDiscoverers