Package software.amazon.awscdk.services.aps

Class CfnWorkspace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.aps.CfnWorkspace
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.752Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkspace

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

    • CfnWorkspace

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

    • CfnWorkspace

      @Stability(Stable) public CfnWorkspace(@NotNull 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(Stable) public CfnWorkspace(@NotNull 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 Details

    • inspect

      @Stability(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(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(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(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(Stable) @NotNull public String getAttrWorkspaceId()
      The workspace ID.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tag keys and values to associate with the workspace.

    • getAlertManagerDefinition

      @Stability(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(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(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(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(Stable) @Nullable public Object getLoggingConfiguration()
      The LoggingConfiguration attribute is used to set the logging configuration for the workspace.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable CfnWorkspace.LoggingConfigurationProperty value)
      The LoggingConfiguration attribute is used to set the logging configuration for the workspace.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable IResolvable value)
      The LoggingConfiguration attribute is used to set the logging configuration for the workspace.