CfnWorkspaceProps

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

Bases: object

Properties for defining a CfnWorkspace.

Parameters:

alert_manager_definition (Optional[str]) – The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. For details about the alert manager definition, see Creating an alert manager configuration files in the Amazon Managed Service for Prometheus User Guide . The following example shows part of a CloudFormation YAML file with an embedded alert manager definition (following the - |- ). Workspace: Type: AWS::APS::Workspace .... Properties: .... AlertManagerDefinition: Fn::Sub: - |- alertmanager_config: | templates: - 'default_template' route: receiver: example-sns receivers: - name: example-sns sns_configs: - topic_arn: 'arn:aws:sns:${AWS::Region}:${AWS::AccountId}:${TopicName}' -
alias (Optional[str]) – The alias that is assigned to this workspace to help identify it. It does not need to be unique.
kms_key_arn (Optional[str]) – (optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide .
logging_configuration (Union[IResolvable, LoggingConfigurationProperty, Dict[str, Any], None]) – Contains information about the logging configuration for the workspace.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The list of tag keys and values that are associated with the workspace.

See:

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.
from aws_cdk import aws_aps as aps

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

Attributes

alert_manager_definition

The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.

For details about the alert manager definition, see Creating an alert manager configuration files in the Amazon Managed Service for Prometheus User Guide .

The following example shows part of a CloudFormation YAML file with an embedded alert manager definition (following the - |- ).

Workspace: Type: AWS::APS::Workspace .... Properties: .... AlertManagerDefinition: Fn::Sub: - |- alertmanager_config: | templates: - 'default_template' route: receiver: example-sns receivers: - name: example-sns sns_configs: - topic_arn: 'arn:aws:sns:${AWS::Region}:${AWS::AccountId}:${TopicName}' -