AWS::APS::RuleGroupsNamespace - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::APS::RuleGroupsNamespace

The definition of a rule groups namespace in an Amazon Managed Service for Prometheus workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. For more information about rules files, see Creating a rules file, in the Amazon Managed Service for Prometheus User Guide.

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 file used in the namespace.

For more details about the rules file, see Creating a rules file in the Amazon Managed Service for Prometheus User Guide.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the rule groups namespace.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

Tags

The list of tag keys and values that are associated with the rule groups namespace.

Required: No

Type: Array of Tag

Update requires: No interruption

Workspace

The ID of the workspace to add the rule groups namespace.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "Arn" }

For more information about using the Ref function, see Ref.

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 rule groups namespace. For example, arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1.