rule_groups_namespaces

Creates, updates, deletes or gets a rule_groups_namespace resource or lists rule_groups_namespaces in a region

Overview

Name	rule_groups_namespaces
Type	Resource
Description	RuleGroupsNamespace schema for cloudformation.
Id	aws.aps.rule_groups_namespaces

Fields

Name	Datatype	Description
workspace	string	Required to identify a specific APS Workspace associated with this RuleGroupsNamespace.
name	string	The RuleGroupsNamespace name.
data	string	The RuleGroupsNamespace data.
arn	string	The RuleGroupsNamespace ARN.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Workspace, Data, Name, 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 rule_groups_namespaces in a region.

SELECT
region,
workspace,
name,
data,
arn,
tags
FROM aws.aps.rule_groups_namespaces
WHERE region = 'us-east-1';

Gets all properties from an individual rule_groups_namespace.

SELECT
region,
workspace,
name,
data,
arn,
tags
FROM aws.aps.rule_groups_namespaces
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.aps.rule_groups_namespaces (
 Workspace,
 Name,
 Data,
 region
)
SELECT 
'{{ Workspace }}',
 '{{ Name }}',
 '{{ Data }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.aps.rule_groups_namespaces (
 Workspace,
 Name,
 Data,
 Tags,
 region
)
SELECT 
 '{{ Workspace }}',
 '{{ Name }}',
 '{{ Data }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: rule_groups_namespace
    props:
      - name: Workspace
        value: '{{ Workspace }}'
      - name: Name
        value: '{{ Name }}'
      - name: Data
        value: '{{ Data }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.aps.rule_groups_namespaces
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

aps:CreateRuleGroupsNamespace,
aps:DescribeRuleGroupsNamespace,
aps:TagResource

Read

aps:DescribeRuleGroupsNamespace,
aps:ListTagsForResource

Update

aps:PutRuleGroupsNamespace,
aps:DescribeRuleGroupsNamespace,
aps:TagResource,
aps:UntagResource,
aps:ListTagsForResource

Delete

aps:DeleteRuleGroupsNamespace,
aps:DescribeRuleGroupsNamespace

List

aps:ListRuleGroupsNamespaces,
aps:ListTagsForResource