awsaps

Documentation

Index

• func CfnRuleGroupsNamespace_CFN_RESOURCE_TYPE_NAME() *string
• func CfnRuleGroupsNamespace_IsCfnElement(x interface{}) *bool
• func CfnRuleGroupsNamespace_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnRuleGroupsNamespace_IsConstruct(x interface{}) *bool
• func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string
• func CfnWorkspace_IsCfnElement(x interface{}) *bool
• func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnWorkspace_IsConstruct(x interface{}) *bool
• func NewCfnRuleGroupsNamespace_Override(c CfnRuleGroupsNamespace, scope constructs.Construct, id *string, ...)
• func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, ...)
• type CfnRuleGroupsNamespace
  • func NewCfnRuleGroupsNamespace(scope constructs.Construct, id *string, props *CfnRuleGroupsNamespaceProps) CfnRuleGroupsNamespace
• type CfnRuleGroupsNamespaceProps
• type CfnWorkspace
  • func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace
• type CfnWorkspaceProps

Functions

func CfnRuleGroupsNamespace_CFN_RESOURCE_TYPE_NAME

func CfnRuleGroupsNamespace_CFN_RESOURCE_TYPE_NAME() *string

func CfnRuleGroupsNamespace_IsCfnElement

func CfnRuleGroupsNamespace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnRuleGroupsNamespace_IsCfnResource

func CfnRuleGroupsNamespace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRuleGroupsNamespace_IsConstruct

func CfnRuleGroupsNamespace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkspace_IsCfnElement

func CfnWorkspace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnWorkspace_IsCfnResource

func CfnWorkspace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnWorkspace_IsConstruct

func CfnWorkspace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnRuleGroupsNamespace_Override

func NewCfnRuleGroupsNamespace_Override(c CfnRuleGroupsNamespace, scope constructs.Construct, id *string, props *CfnRuleGroupsNamespaceProps)

Create a new `AWS::APS::RuleGroupsNamespace`.

func NewCfnWorkspace_Override

func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, props *CfnWorkspaceProps)

Create a new `AWS::APS::Workspace`.

Types

type CfnRuleGroupsNamespace

type CfnRuleGroupsNamespace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Data() *string
	SetData(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Workspace() *string
	SetWorkspace(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-Ruler.html) .

TODO: EXAMPLE

func NewCfnRuleGroupsNamespace

func NewCfnRuleGroupsNamespace(scope constructs.Construct, id *string, props *CfnRuleGroupsNamespaceProps) CfnRuleGroupsNamespace

Create a new `AWS::APS::RuleGroupsNamespace`.

type CfnRuleGroupsNamespaceProps

type CfnRuleGroupsNamespaceProps struct {
	// The rules definition file for this namespace.
	Data *string `json:"data" yaml:"data"`
	// The name of the rule groups namespace.
	//
	// This property is required.
	Name *string `json:"name" yaml:"name"`
	// The ARN of the workspace that contains this rule groups namespace.
	Workspace *string `json:"workspace" yaml:"workspace"`
	// A list of key and value pairs for the workspace resources.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnRuleGroupsNamespace`.

TODO: EXAMPLE

type CfnWorkspace

type CfnWorkspace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AlertManagerDefinition() *string
	SetAlertManagerDefinition(val *string)
	Alias() *string
	SetAlias(val *string)
	AttrArn() *string
	AttrPrometheusEndpoint() *string
	AttrWorkspaceId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::APS::Workspace`.

The `AWS::APS::Workspace` type specifies an Amazon Managed Service for Prometheus ( Amazon Managed Service for Prometheus ) workspace. A *workspace* is a logical and isolated Prometheus server dedicated to Prometheus resources such as metrics. You can have one or more workspaces in each Region in your account.

TODO: EXAMPLE

func NewCfnWorkspace

func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace

Create a new `AWS::APS::Workspace`.

type CfnWorkspaceProps

type CfnWorkspaceProps struct {
	// The alert manager definition for the workspace, as a string.
	//
	// For more information, see [Alert manager and templating](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alert-manager.html) .
	AlertManagerDefinition *string `json:"alertManagerDefinition" yaml:"alertManagerDefinition"`
	// An alias that you assign to this workspace to help you identify it.
	//
	// It does not need to be unique.
	//
	// The alias can be as many as 100 characters and can include any type of characters. Amazon Managed Service for Prometheus automatically strips any blank spaces from the beginning and end of the alias that you specify.
	Alias *string `json:"alias" yaml:"alias"`
	// A list of tag keys and values to associate with the workspace.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnWorkspace`.

TODO: EXAMPLE