Package software.amazon.awscdk.cfnpropertymixins.services.aps

Class CfnWorkspacePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.aps.CfnWorkspacePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkspacePropsMixin>

Enclosing class:

CfnWorkspacePropsMixin

@Stability(Stable)
public static final class CfnWorkspacePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkspacePropsMixin>

A fluent builder for CfnWorkspacePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnWorkspacePropsMixin.Builder	alertManagerDefinition(String alertManagerDefinition)	The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
CfnWorkspacePropsMixin.Builder	alias(String alias)	The alias that is assigned to this workspace to help identify it.
CfnWorkspacePropsMixin	build()
static CfnWorkspacePropsMixin.Builder	create()
static CfnWorkspacePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnWorkspacePropsMixin.Builder	kmsKeyArn(String kmsKeyArn)	(optional) The ARN for a customer managed AWS key to use for encrypting data within your workspace.
CfnWorkspacePropsMixin.Builder	loggingConfiguration(CfnWorkspacePropsMixin.LoggingConfigurationProperty loggingConfiguration)	Contains information about the logging configuration for the workspace.
CfnWorkspacePropsMixin.Builder	loggingConfiguration(IResolvable loggingConfiguration)	Contains information about the logging configuration for the workspace.
CfnWorkspacePropsMixin.Builder	queryLoggingConfiguration(CfnWorkspacePropsMixin.QueryLoggingConfigurationProperty queryLoggingConfiguration)	The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
CfnWorkspacePropsMixin.Builder	queryLoggingConfiguration(IResolvable queryLoggingConfiguration)	The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
CfnWorkspacePropsMixin.Builder	tags(List<? extends CfnTag> tags)	The list of tag keys and values that are associated with the workspace.
CfnWorkspacePropsMixin.Builder	workspaceConfiguration(CfnWorkspacePropsMixin.WorkspaceConfigurationProperty workspaceConfiguration)	Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
CfnWorkspacePropsMixin.Builder	workspaceConfiguration(IResolvable workspaceConfiguration)	Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnWorkspacePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnWorkspacePropsMixin.Builder.

create

@Stability(Stable)
public static CfnWorkspacePropsMixin.Builder create()

Returns:

a new instance of CfnWorkspacePropsMixin.Builder.

alertManagerDefinition

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder alertManagerDefinition(String alertManagerDefinition)

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}' -

Parameters:

alertManagerDefinition - The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. This parameter is required.

Returns:

this

See Also:

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

alias

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder alias(String alias)

The alias that is assigned to this workspace to help identify it.

It does not need to be unique.

Parameters:

alias - The alias that is assigned to this workspace to help identify it. This parameter is required.

Returns:

this

See Also:

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

kmsKeyArn

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder kmsKeyArn(String kmsKeyArn)

(optional) The ARN for a customer managed AWS 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 .

Parameters:

kmsKeyArn - (optional) The ARN for a customer managed AWS key to use for encrypting data within your workspace. This parameter is required.

Returns:

this

See Also:

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

loggingConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder loggingConfiguration(IResolvable loggingConfiguration)

Contains information about the logging configuration for the workspace.

Parameters:

loggingConfiguration - Contains information about the logging configuration for the workspace. This parameter is required.

Returns:

this

See Also:

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

loggingConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder loggingConfiguration(CfnWorkspacePropsMixin.LoggingConfigurationProperty loggingConfiguration)

Contains information about the logging configuration for the workspace.

Parameters:

loggingConfiguration - Contains information about the logging configuration for the workspace. This parameter is required.

Returns:

this

See Also:

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

queryLoggingConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder queryLoggingConfiguration(IResolvable queryLoggingConfiguration)

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

Parameters:

queryLoggingConfiguration - The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. This parameter is required.

Returns:

this

See Also:

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

queryLoggingConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder queryLoggingConfiguration(CfnWorkspacePropsMixin.QueryLoggingConfigurationProperty queryLoggingConfiguration)

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

Parameters:

queryLoggingConfiguration - The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder tags(List<? extends CfnTag> tags)

The list of tag keys and values that are associated with the workspace.

Parameters:

tags - The list of tag keys and values that are associated with the workspace. This parameter is required.

Returns:

this

See Also:

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

workspaceConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder workspaceConfiguration(IResolvable workspaceConfiguration)

Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.

Parameters:

workspaceConfiguration - Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. This parameter is required.

Returns:

this

See Also:

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

workspaceConfiguration

@Stability(Stable)
public CfnWorkspacePropsMixin.Builder workspaceConfiguration(CfnWorkspacePropsMixin.WorkspaceConfigurationProperty workspaceConfiguration)

Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.

Parameters:

workspaceConfiguration - Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnWorkspacePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnWorkspacePropsMixin>

Returns:

a newly built instance of CfnWorkspacePropsMixin.