Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:26.552Z") @Stability(Stable) public class CfnWorkspace extends CfnResource implements IInspectable, ITaggable
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.services.aps.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .alertManagerDefinition("alertManagerDefinition")
         .alias("alias")
         .kmsKeyArn("kmsKeyArn")
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .logGroupArn("logGroupArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnWorkspaceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnWorkspace

      @Stability(Stable) public CfnWorkspace(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234 .

    • getAttrPrometheusEndpoint

      @Stability(Stable) @NotNull public String getAttrPrometheusEndpoint()
      The Prometheus endpoint available for this workspace.

      For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/ .

    • getAttrWorkspaceId

      @Stability(Stable) @NotNull public String getAttrWorkspaceId()
      The unique ID for the workspace.

      For example, ws-example1-1234-abcd-5678-ef90abcd1234 .

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAlertManagerDefinition

      @Stability(Stable) @Nullable public String getAlertManagerDefinition()
      The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.

    • setAlertManagerDefinition

      @Stability(Stable) public void setAlertManagerDefinition(@Nullable String value)
      The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.

    • getAlias

      @Stability(Stable) @Nullable public String getAlias()
      The alias that is assigned to this workspace to help identify it.

    • setAlias

      @Stability(Stable) public void setAlias(@Nullable String value)
      The alias that is assigned to this workspace to help identify it.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      (optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      (optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace.

    • getLoggingConfiguration

      @Stability(Stable) @Nullable public Object getLoggingConfiguration()
      Contains information about the logging configuration for the workspace.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable IResolvable value)
      Contains information about the logging configuration for the workspace.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable CfnWorkspace.LoggingConfigurationProperty value)
      Contains information about the logging configuration for the workspace.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tag keys and values that are associated with the workspace.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tag keys and values that are associated with the workspace.