Package software.amazon.awscdk.services.aps

Interface CfnWorkspaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.598Z")
@Stability(Stable)
public interface CfnWorkspaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkspace.

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.*;
 CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
         .alertManagerDefinition("alertManagerDefinition")
         .alias("alias")
         .kmsKeyArn("kmsKeyArn")
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .logGroupArn("logGroupArn")
                 .build())
         .queryLoggingConfiguration(QueryLoggingConfigurationProperty.builder()
                 .destinations(List.of(LoggingDestinationProperty.builder()
                         .cloudWatchLogs(CloudWatchLogDestinationProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .filters(LoggingFilterProperty.builder()
                                 .qspThreshold(123)
                                 .build())
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workspaceConfiguration(WorkspaceConfigurationProperty.builder()
                 .limitsPerLabelSets(List.of(LimitsPerLabelSetProperty.builder()
                         .labelSet(List.of(LabelProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .limits(LimitsPerLabelSetEntryProperty.builder()
                                 .maxSeries(123)
                                 .build())
                         .build()))
                 .retentionPeriodInDays(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspaceProps.Builder	A builder for CfnWorkspaceProps
static final class	CfnWorkspaceProps.Jsii$Proxy	An implementation for CfnWorkspaceProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspaceProps.Builder	builder()
default String	getAlertManagerDefinition()	The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
default String	getAlias()	The alias that is assigned to this workspace to help identify it.
default String	getKmsKeyArn()	(optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace.
default Object	getLoggingConfiguration()	Contains information about the logging configuration for the workspace.
default Object	getQueryLoggingConfiguration()	The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
default List<CfnTag>	getTags()	The list of tag keys and values that are associated with the workspace.
default Object	getWorkspaceConfiguration()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlertManagerDefinition

@Stability(Stable)
@Nullable
default String getAlertManagerDefinition()

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 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}' -

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alertmanagerdefinition

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

The alias that is assigned to this workspace to help identify it.

It does not need to be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alias

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

(optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace.

For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-kmskeyarn

getLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getLoggingConfiguration()

Contains information about the logging configuration for the workspace.

Returns union: either IResolvable or CfnWorkspace.LoggingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-loggingconfiguration

getQueryLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getQueryLoggingConfiguration()

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

Returns union: either IResolvable or CfnWorkspace.QueryLoggingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-queryloggingconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-tags

getWorkspaceConfiguration

@Stability(Stable)
@Nullable
default Object getWorkspaceConfiguration()

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.

Returns union: either IResolvable or CfnWorkspace.WorkspaceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-workspaceconfiguration

builder

@Stability(Stable)
static CfnWorkspaceProps.Builder builder()

Returns:

a CfnWorkspaceProps.Builder of CfnWorkspaceProps