software.amazon.awscdk.services.aps

Class CfnWorkspace

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.aps.CfnWorkspace

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.688Z")
 @Stability(value=Stable)
public class CfnWorkspace
extends CfnResource
implements IInspectable

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.

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.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .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	Class and Description
static class	CfnWorkspace.Builder A fluent builder for CfnWorkspace.
static interface	CfnWorkspace.LoggingConfigurationProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkspace(software.constructs.Construct scope, String id) Create a new `AWS::APS::Workspace`.
	CfnWorkspace(software.constructs.Construct scope, String id, CfnWorkspaceProps props) Create a new `AWS::APS::Workspace`.
protected	CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAlertManagerDefinition() The alert manager definition for the workspace, as a string.
String	getAlias() An alias that you assign to this workspace to help you identify it.
String	getAttrArn() The ARN of the workspace.
String	getAttrPrometheusEndpoint() The Prometheus endpoint attribute of the workspace.
String	getAttrWorkspaceId() The workspace ID.
protected Map<String,Object>	getCfnProperties()
Object	getLoggingConfiguration() `AWS::APS::Workspace.LoggingConfiguration`.
TagManager	getTags() A list of tag keys and values to associate with the workspace.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAlertManagerDefinition(String value) The alert manager definition for the workspace, as a string.
void	setAlias(String value) An alias that you assign to this workspace to help you identify it.
void	setLoggingConfiguration(CfnWorkspace.LoggingConfigurationProperty value) `AWS::APS::Workspace.LoggingConfiguration`.
void	setLoggingConfiguration(IResolvable value) `AWS::APS::Workspace.LoggingConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkspace

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

CfnWorkspace

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

CfnWorkspace

@Stability(value=Stable)
public CfnWorkspace(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             CfnWorkspaceProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnWorkspace

@Stability(value=Stable)
public CfnWorkspace(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the workspace.

For example: arn:aws:aps:us-west-2:123456789012:workspace/ws-EXAMPLE-3687-4ac9-853c-EXAMPLEe8f .

getAttrPrometheusEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrPrometheusEndpoint()

The Prometheus endpoint attribute of the workspace.

This is the endpoint prefix without the remote_write or query API appended. For example: https://aps-workspaces.us-west-2.amazonaws.com/workspaces/ws-EXAMPLE-3687-4ac9-853c-EXAMPLEe8f/ .

getAttrWorkspaceId

@Stability(value=Stable)
 @NotNull
public String getAttrWorkspaceId()

The workspace ID.

For example: ws-EXAMPLE-3687-4ac9-853c-EXAMPLEe8f .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAlertManagerDefinition

@Stability(value=Stable)
 @Nullable
public String getAlertManagerDefinition()

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

For more information, see Alert manager and templating .

setAlertManagerDefinition

@Stability(value=Stable)
public void setAlertManagerDefinition(@Nullable
                                                               String value)

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

For more information, see Alert manager and templating .

getAlias

@Stability(value=Stable)
 @Nullable
public 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.

setAlias

@Stability(value=Stable)
public void setAlias(@Nullable
                                              String value)

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

@Stability(value=Stable)
 @Nullable
public Object getLoggingConfiguration()

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

setLoggingConfiguration

@Stability(value=Stable)
public void setLoggingConfiguration(@Nullable
                                                             CfnWorkspace.LoggingConfigurationProperty value)

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

setLoggingConfiguration

@Stability(value=Stable)
public void setLoggingConfiguration(@Nullable
                                                             IResolvable value)

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