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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.688Z")
 @Stability(value=Stable)
public class CfnRuleGroupsNamespace
extends CfnResource
implements IInspectable

A CloudFormation `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 .

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRuleGroupsNamespace.Builder A fluent builder for CfnRuleGroupsNamespace.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRuleGroupsNamespace(software.constructs.Construct scope, String id, CfnRuleGroupsNamespaceProps props) Create a new `AWS::APS::RuleGroupsNamespace`.
protected	CfnRuleGroupsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroupsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the rules group namespace.
protected Map<String,Object>	getCfnProperties()
String	getData() The rules definition file for this namespace.
String	getName() The name of the rule groups namespace.
TagManager	getTags() A list of key and value pairs for the workspace resources.
String	getWorkspace() The ARN of the workspace that contains this rule groups namespace.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setData(String value) The rules definition file for this namespace.
void	setName(String value) The name of the rule groups namespace.
void	setWorkspace(String value) The ARN of the workspace that contains this rule groups namespace.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRuleGroupsNamespace

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

CfnRuleGroupsNamespace

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

CfnRuleGroupsNamespace

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of key and value pairs for the workspace resources.

getData

@Stability(value=Stable)
 @NotNull
public String getData()

The rules definition file for this namespace.

setData

@Stability(value=Stable)
public void setData(@NotNull
                                             String value)

The rules definition file for this namespace.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the rule groups namespace.

This property is required.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the rule groups namespace.

This property is required.

getWorkspace

@Stability(value=Stable)
 @NotNull
public String getWorkspace()

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

setWorkspace

@Stability(value=Stable)
public void setWorkspace(@NotNull
                                                  String value)

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