Package software.amazon.awscdk.services.aps

Class CfnRuleGroupsNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.aps.CfnRuleGroupsNamespace
All Implemented Interfaces:
IInspectable, IRuleGroupsNamespaceRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:06.013Z") @Stability(Stable) public class CfnRuleGroupsNamespace extends CfnResource implements IInspectable, IRuleGroupsNamespaceRef, ITaggable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.aps.*;
 CfnRuleGroupsNamespace cfnRuleGroupsNamespace = CfnRuleGroupsNamespace.Builder.create(this, "MyCfnRuleGroupsNamespace")
         .data("data")
         .name("name")
         .workspace("workspace")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRuleGroupsNamespace

      protected CfnRuleGroupsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRuleGroupsNamespace

      protected CfnRuleGroupsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRuleGroupsNamespace

      @Stability(Stable) public CfnRuleGroupsNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRuleGroupsNamespaceProps props)
      Create a new AWS::APS::RuleGroupsNamespace.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForRuleGroupsNamespace

      @Stability(Stable) @NotNull public static String arnForRuleGroupsNamespace(@NotNull IRuleGroupsNamespaceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRuleGroupsNamespace

      @Stability(Stable) @NotNull public static Boolean isCfnRuleGroupsNamespace(@NotNull Object x)
      Checks whether the given object is a CfnRuleGroupsNamespace.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the rule groups namespace.

      For example, arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRuleGroupsNamespaceRef

      @Stability(Stable) @NotNull public RuleGroupsNamespaceReference getRuleGroupsNamespaceRef()
      A reference to a RuleGroupsNamespace resource.
      Specified by:
      getRuleGroupsNamespaceRef in interface IRuleGroupsNamespaceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getData

      @Stability(Stable) @NotNull public String getData()
      The rules file used in the namespace.

    • setData

      @Stability(Stable) public void setData(@NotNull String value)
      The rules file used in the namespace.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the rule groups namespace.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the rule groups namespace.

    • getWorkspace

      @Stability(Stable) @NotNull public String getWorkspace()
      The ID of the workspace to add the rule groups namespace.

    • setWorkspace

      @Stability(Stable) public void setWorkspace(@NotNull String value)
      The ID of the workspace to add the rule groups namespace.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tag keys and values that are associated with the rule groups namespace.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tag keys and values that are associated with the rule groups namespace.