RuleGroupNamespace class

Manages an Amazon Managed Service for Prometheus (AMP) Rule Group Namespace

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const demo = new aws.amp.Workspace("demo", {});
const demoRuleGroupNamespace = new aws.amp.RuleGroupNamespace("demo", {
    name: "rules",
    workspaceId: demo.id,
    data: `groups:
  - name: test
    rules:
    - record: metric:recording_rule
      expr: avg(rate(container_cpu_usage_seconds_total[5m]))
`,
});
import pulumi
import pulumi_aws as aws

demo = aws.amp.Workspace("demo")
demo_rule_group_namespace = aws.amp.RuleGroupNamespace("demo",
    name="rules",
    workspace_id=demo.id,
    data="""groups:
  - name: test
    rules:
    - record: metric:recording_rule
      expr: avg(rate(container_cpu_usage_seconds_total[5m]))
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var demo = new Aws.Amp.Workspace("demo");

    var demoRuleGroupNamespace = new Aws.Amp.RuleGroupNamespace("demo", new()
    {
        Name = "rules",
        WorkspaceId = demo.Id,
        Data = @"groups:
  - name: test
    rules:
    - record: metric:recording_rule
      expr: avg(rate(container_cpu_usage_seconds_total[5m]))
",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		demo, err := amp.NewWorkspace(ctx, "demo", nil)
		if err != nil {
			return err
		}
		_, err = amp.NewRuleGroupNamespace(ctx, "demo", &amp.RuleGroupNamespaceArgs{
			Name:        pulumi.String("rules"),
			WorkspaceId: demo.ID().ToIDOutput().ToStringOutput(),
			Data: pulumi.String(`groups:
  - name: test
    rules:
    - record: metric:recording_rule
      expr: avg(rate(container_cpu_usage_seconds_total[5m]))
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_amp_workspace" "demo" {
}
resource "aws_amp_rulegroupnamespace" "demo" {
  name         = "rules"
  workspace_id = aws_amp_workspace.demo.id
  data         = "groups:\n  - name: test\n    rules:\n    - record: metric:recording_rule\n      expr: avg(rate(container_cpu_usage_seconds_total[5m]))\n"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.Workspace;
import com.pulumi.aws.amp.RuleGroupNamespace;
import com.pulumi.aws.amp.RuleGroupNamespaceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var demo = new Workspace("demo");

        var demoRuleGroupNamespace = new RuleGroupNamespace("demoRuleGroupNamespace", RuleGroupNamespaceArgs.builder()
            .name("rules")
            .workspaceId(demo.id())
            .data("""
groups:
  - name: test
    rules:
    - record: metric:recording_rule
      expr: avg(rate(container_cpu_usage_seconds_total[5m]))
            """)
            .build());

    }
}
resources:
  demo:
    type: aws:amp:Workspace
  demoRuleGroupNamespace:
    type: aws:amp:RuleGroupNamespace
    name: demo
    properties:
      name: rules
      workspaceId: ${demo.id}
      data: |
        groups:
          - name: test
            rules:
            - record: metric:recording_rule
              expr: avg(rate(container_cpu_usage_seconds_total[5m]))

Import

Identity Schema

Required

  • arn (String) ARN of the Prometheus rule group namespace.

Using pulumi import, import the prometheus rule group namespace using the arn. For example:

$ pulumi import aws:amp/ruleGroupNamespace:RuleGroupNamespace demo arn:aws:aps:us-west-2:123456789012:rulegroupsnamespace/IDstring/namespace_name

Constructors

RuleGroupNamespace(String name, {RuleGroupNamespaceArgs? args, CustomResourceOptions? options})
Creates a new RuleGroupNamespace. name The Pulumi resource name. args Arguments used to configure this RuleGroupNamespace. The set of arguments for RuleGroupNamespace. options Resource options controlling this resource's behavior.
RuleGroupNamespace.reference(String urn)
Creates a typed reference to an existing RuleGroupNamespace resource.

Properties

arn ↔ Output<String>
The ARN of the rule group namespace.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
data ↔ Output<String>
the rule group namespace data that you want to be applied. See more in AWS Docs.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the rule group namespace.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
workspaceId ↔ Output<String>
ID of the prometheus workspace the rule group namespace should be linked to.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RuleGroupNamespaceState? state, CustomResourceOptions? options}) → RuleGroupNamespace
Gets an existing RuleGroupNamespace resource's state with the given name and id.