AWS::APS::RuleGroupsNamespace

The AWS::APS::RuleGroupsNamespace resource creates or updates a rule groups namespace within a Amazon Managed Service for Prometheus workspace. For more information, see Recording rules and alerting rules.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::APS::RuleGroupsNamespace",
  "Properties" : {
      "Data" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "Workspace" : String
    }
}

YAML

Type: AWS::APS::RuleGroupsNamespace
Properties: 
  Data: String
  Name: String
  Tags: 
    - Tag
  Workspace: String

Properties

Data

The rules definition file for this namespace.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the rule groups namespace. This property is required.

Required: Yes

Type: String

Update requires: Replacement

Tags

Not currently supported by AWS CloudFormation.

Required: No

Type: List of Tag

Update requires: No interruption

Workspace

The ARN of the workspace that contains this rule groups namespace.

Required: Yes

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the rules group namespace. For example, arn:aws:aps:us-west-2:123456789012:rulegroupsnamespace/ws-EXAMPLE-3687-4ac9-853c-EXAMPLEe8f/amp-rules.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the rules group namespace. For example, arn:aws:aps:us-west-2:123456789012:rulegroupsnamespace/ws-EXAMPLE-3687-4ac9-853c-EXAMPLEe8f/amp=rules