CfnWorkspaceProps

class aws_cdk.aws_aps.CfnWorkspaceProps(*, alert_manager_definition=None, alias=None, logging_configuration=None, tags=None)

Bases: object

Properties for defining a CfnWorkspace.

Parameters:

alert_manager_definition (Optional[str]) – The alert manager definition for the workspace, as a string. For more information, see Alert manager and templating .
alias (Optional[str]) – 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.
logging_configuration (Union[LoggingConfigurationProperty, Dict[str, Any], IResolvable, None]) – The LoggingConfiguration attribute is used to set the logging configuration for the workspace.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tag keys and values to associate with the workspace.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_aps as aps

cfn_workspace_props = aps.CfnWorkspaceProps(
    alert_manager_definition="alertManagerDefinition",
    alias="alias",
    logging_configuration=aps.CfnWorkspace.LoggingConfigurationProperty(
        log_group_arn="logGroupArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alert_manager_definition

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

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.

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

logging_configuration

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

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.

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