Class CfnWorkspace

A CloudFormation AWS::APS::Workspace.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnWorkspace
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.APS
Assembly: Amazon.CDK.AWS.APS.dll
Syntax (csharp)
public class CfnWorkspace : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWorkspace
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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.

CloudformationResource: AWS::APS::Workspace

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html

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",
    LoggingConfiguration = new LoggingConfigurationProperty {
        LogGroupArn = "logGroupArn"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnWorkspace(Construct, String, ICfnWorkspaceProps)

Create a new AWS::APS::Workspace.
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

Properties

AlertManagerDefinition

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

An alias that you assign to this workspace to help you identify it.
AttrArn

The ARN of the workspace.
AttrPrometheusEndpoint

The Prometheus endpoint attribute of the workspace.
AttrWorkspaceId

The workspace ID.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
LoggingConfiguration

The LoggingConfiguration attribute is used to set the logging configuration for the workspace.
Tags

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnWorkspace(Construct, String, ICfnWorkspaceProps)

Create a new AWS::APS::Workspace.

public CfnWorkspace(Construct scope, string id, ICfnWorkspaceProps props = null)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnWorkspaceProps
  • resource properties.

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

Properties

AlertManagerDefinition

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

public virtual string AlertManagerDefinition { get; set; }
Property Value

System.String

Remarks

For more information, see Alert manager and templating .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alertmanagerdefinition

Alias

An alias that you assign to this workspace to help you identify it.

public virtual string Alias { get; set; }
Property Value

System.String

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-alias

AttrArn

The ARN of the workspace.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

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

CloudformationAttribute: Arn

AttrPrometheusEndpoint

The Prometheus endpoint attribute of the workspace.

public virtual string AttrPrometheusEndpoint { get; }
Property Value

System.String

Remarks

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/ .

CloudformationAttribute: PrometheusEndpoint

AttrWorkspaceId

The workspace ID.

public virtual string AttrWorkspaceId { get; }
Property Value

System.String

Remarks

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

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

LoggingConfiguration

The LoggingConfiguration attribute is used to set the logging configuration for the workspace.

public virtual object LoggingConfiguration { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-loggingconfiguration

Tags

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

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-workspace.html#cfn-aps-workspace-tags

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>

Overrides

Implements

Constructs.IConstruct