AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::APS::Workspace

CfnWorkspace

An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.

Import

import { CfnWorkspace } from 'aws-cdk-lib/aws-aps';

Or use the module namespace:

import * as aps from 'aws-cdk-lib/aws-aps';
// aps.CfnWorkspace

Properties

Configuration passed to the constructor as CfnWorkspaceProps.

alertManagerDefinitionOptional
string

The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. For details about the alert manager definition, see [Creating an alert manager configuration files](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alertmanager-config.html) in the *Amazon Managed Service for Prometheus User Guide* . The following example shows part of a CloudFormation YAML file with an embedded alert manager definition (following the `- |-` ). `Workspace: Type: AWS::APS::Workspace .... Properties: .... AlertManagerDefinition: Fn::Sub: - |- alertmanager_config: | templates: - 'default_template' route: receiver: example-sns receivers: - name: example-sns sns_configs: - topic_arn: 'arn:aws:sns:${AWS::Region}:${AWS::AccountId}:${TopicName}' -`

aliasOptional
string

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

kmsKeyArnOptional
string

(optional) The ARN for a customer managed AWS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see [Encryption at rest](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) in the *Amazon Managed Service for Prometheus User Guide* .

loggingConfigurationOptional
IResolvable | LoggingConfigurationProperty

Contains information about the logging configuration for the workspace.

queryLoggingConfigurationOptional
IResolvable | QueryLoggingConfigurationProperty

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

tagsOptional
CfnTag[]

The list of tag keys and values that are associated with the workspace.

workspaceConfigurationOptional
IResolvable | WorkspaceConfigurationProperty

Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-aps
CFN TypeAWS::APS::Workspace
Properties7

External Links