software.amazon.awscdk.services.aps

Interface CfnWorkspaceProps

All Known Implementing Classes:

CfnWorkspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:32.412Z")
public interface CfnWorkspaceProps

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")
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .logGroupArn("logGroupArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWorkspaceProps.Builder	builder()
default java.lang.String	getAlertManagerDefinition() The alert manager definition for the workspace, as a string.
default java.lang.String	getAlias() An alias that you assign to this workspace to help you identify it.
default java.lang.Object	getLoggingConfiguration() `AWS::APS::Workspace.LoggingConfiguration`.
default java.util.List<CfnTag>	getTags() A list of tag keys and values to associate with the workspace.

Method Detail

getAlertManagerDefinition

default java.lang.String getAlertManagerDefinition()

The alert manager definition for the workspace, as a string.

For more information, see Alert manager and templating .

getAlias

default java.lang.String getAlias()

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.

getLoggingConfiguration

default java.lang.Object getLoggingConfiguration()

`AWS::APS::Workspace.LoggingConfiguration`.

getTags

default java.util.List<CfnTag> getTags()

A list of tag keys and values to associate with the workspace.

builder

static CfnWorkspaceProps.Builder builder()

Returns:

a CfnWorkspaceProps.Builder of CfnWorkspaceProps