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	awscc.aps.rule_groups_namespaces

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The RuleGroupsNamespace ARN.
region	string	AWS region.

For more information, see AWS::APS::RuleGroupsNamespace.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rule_groups_namespaces	INSERT	Workspace, Data, Name, region
delete_resource	rule_groups_namespaces	DELETE	Identifier, region
update_resource	rule_groups_namespaces	UPDATE	Identifier, PatchDocument, region
list_resources	rule_groups_namespaces_list_only	SELECT	region
get_resource	rule_groups_namespaces	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual rule_groups_namespace.

SELECT
  region,
  workspace,
  name,
  data,
  arn,
  tags
FROM awscc.aps.rule_groups_namespaces
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all rule_groups_namespaces in a region.

SELECT
  region,
  arn
FROM awscc.aps.rule_groups_namespaces_list_only
WHERE
  region = '{{ region }}';

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 awscc.aps.rule_groups_namespaces (
  Workspace,
  Name,
  Data,
  region
)
SELECT
  '{{ workspace }}',
  '{{ name }}',
  '{{ data }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.aps.rule_groups_namespaces (
  Workspace,
  Name,
  Data,
  Tags,
  region
)
SELECT
  '{{ workspace }}',
  '{{ name }}',
  '{{ data }}',
  '{{ tags }}',
  '{{ 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: rule_groups_namespace
  props:
    - name: workspace
      value: '{{ workspace }}'
    - name: name
      value: '{{ name }}'
    - name: data
      value: '{{ data }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.aps.rule_groups_namespaces
SET PatchDocument = string('{{ {
    "Data": data,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.aps.rule_groups_namespaces
WHERE
  Identifier = '{{ arn }}' 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 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