Package software.amazon.awscdk.cfnpropertymixins.services.aps

Class CfnWorkspacePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.aps.CfnWorkspacePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.043Z")
@Stability(Stable)
public class CfnWorkspacePropsMixin
extends Mixin
implements software.constructs.IMixin

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.aps.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnWorkspacePropsMixin cfnWorkspacePropsMixin = CfnWorkspacePropsMixin.Builder.create(CfnWorkspaceMixinProps.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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnWorkspacePropsMixin.Builder	A fluent builder for CfnWorkspacePropsMixin.
static interface	CfnWorkspacePropsMixin.CloudWatchLogDestinationProperty	Configuration details for logging to CloudWatch Logs.
static interface	CfnWorkspacePropsMixin.LabelProperty	A label is a name:value pair used to add context to ingested metrics.
static interface	CfnWorkspacePropsMixin.LimitsPerLabelSetEntryProperty	This structure contains the limits that apply to time series that match one label set.
static interface	CfnWorkspacePropsMixin.LimitsPerLabelSetProperty	This defines a label set for the workspace, and defines the ingestion limit for active time series that match that label set.
static interface	CfnWorkspacePropsMixin.LoggingConfigurationProperty	Contains information about the rules and alerting logging configuration for the workspace.
static interface	CfnWorkspacePropsMixin.LoggingDestinationProperty	The logging destination in an Amazon Managed Service for Prometheus workspace.
static interface	CfnWorkspacePropsMixin.LoggingFilterProperty	Filtering criteria that determine which queries are logged.
static interface	CfnWorkspacePropsMixin.QueryLoggingConfigurationProperty	The query logging configuration in an Amazon Managed Service for Prometheus workspace.
static interface	CfnWorkspacePropsMixin.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.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnWorkspacePropsMixin(CfnWorkspaceMixinProps props)	Create a mixin to apply properties to AWS::APS::Workspace.
	CfnWorkspacePropsMixin(CfnWorkspaceMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::APS::Workspace.
protected	CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspacePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnWorkspaceMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnWorkspacePropsMixin

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

CfnWorkspacePropsMixin

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

CfnWorkspacePropsMixin

@Stability(Stable)
public CfnWorkspacePropsMixin(@NotNull
 CfnWorkspaceMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::APS::Workspace.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnWorkspacePropsMixin

@Stability(Stable)
public CfnWorkspacePropsMixin(@NotNull
 CfnWorkspaceMixinProps props)

Create a mixin to apply properties to AWS::APS::Workspace.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnWorkspaceMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()