Class CfnWorkspace
An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
Inherited Members
Namespace: Amazon.CDK.AWS.APS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWorkspace : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnWorkspace
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html
CloudformationResource: AWS::APS::Workspace
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APS;
var cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", new CfnWorkspaceProps {
AlertManagerDefinition = "alertManagerDefinition",
Alias = "alias",
KmsKeyArn = "kmsKeyArn",
LoggingConfiguration = new LoggingConfigurationProperty {
LogGroupArn = "logGroupArn"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnWorkspace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWorkspace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnWorkspace(Construct, String, ICfnWorkspaceProps) |
Properties
AlertManagerDefinition | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
Alias | The alias that is assigned to this workspace to help identify it. |
AttrArn | The ARN of the workspace. |
AttrPrometheusEndpoint | The Prometheus endpoint available for this workspace. |
AttrWorkspaceId | The unique ID for the workspace. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
KmsKeyArn | (optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace. |
LoggingConfiguration | Contains information about the logging configuration for the workspace. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The list of tag keys and values that are associated with the workspace. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnWorkspace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWorkspace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWorkspace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWorkspace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnWorkspace(Construct, String, ICfnWorkspaceProps)
public CfnWorkspace(Construct scope, string id, ICfnWorkspaceProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnWorkspaceProps
Resource properties.
Properties
AlertManagerDefinition
The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
public virtual string AlertManagerDefinition { get; set; }
Property Value
System.String
Alias
The alias that is assigned to this workspace to help identify it.
public virtual string Alias { get; set; }
Property Value
System.String
AttrArn
The ARN of the workspace.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234
.
CloudformationAttribute: Arn
AttrPrometheusEndpoint
The Prometheus endpoint available for this workspace.
public virtual string AttrPrometheusEndpoint { get; }
Property Value
System.String
Remarks
For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/
.
CloudformationAttribute: PrometheusEndpoint
AttrWorkspaceId
The unique ID for the workspace.
public virtual string AttrWorkspaceId { get; }
Property Value
System.String
Remarks
For example, ws-example1-1234-abcd-5678-ef90abcd1234
.
CloudformationAttribute: WorkspaceId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
KmsKeyArn
(optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace.
public virtual string KmsKeyArn { get; set; }
Property Value
System.String
LoggingConfiguration
Contains information about the logging configuration for the workspace.
public virtual object LoggingConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The list of tag keys and values that are associated with the workspace.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>