Class CfnRuleGroupsNamespace
The definition of a rule groups namespace in an Amazon Managed Service for Prometheus workspace.
Inherited Members
Namespace: Amazon.CDK.AWS.APS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRuleGroupsNamespace : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnRuleGroupsNamespace
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
CloudformationResource: AWS::APS::RuleGroupsNamespace
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APS;
var cfnRuleGroupsNamespace = new CfnRuleGroupsNamespace(this, "MyCfnRuleGroupsNamespace", new CfnRuleGroupsNamespaceProps {
Data = "data",
Name = "name",
Workspace = "workspace",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnRuleGroupsNamespace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRuleGroupsNamespace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnRuleGroupsNamespace(Construct, String, ICfnRuleGroupsNamespaceProps) |
Properties
AttrArn | The ARN of the rule groups namespace. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Data | The rules file used in the namespace. |
Name | The name of the rule groups namespace. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The list of tag keys and values that are associated with the rule groups namespace. |
Workspace | The ID of the workspace to add the rule groups namespace. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRuleGroupsNamespace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRuleGroupsNamespace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRuleGroupsNamespace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRuleGroupsNamespace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnRuleGroupsNamespace(Construct, String, ICfnRuleGroupsNamespaceProps)
public CfnRuleGroupsNamespace(Construct scope, string id, ICfnRuleGroupsNamespaceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnRuleGroupsNamespaceProps
Resource properties.
Properties
AttrArn
The ARN of the rule groups namespace.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1
.
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Data
The rules file used in the namespace.
public virtual string Data { get; set; }
Property Value
System.String
Name
The name of the rule groups namespace.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The list of tag keys and values that are associated with the rule groups namespace.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Workspace
The ID of the workspace to add the rule groups namespace.
public virtual string Workspace { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>