WorkspaceConfiguration class
Manages an AWS Managed Service for Prometheus Workspace Configuration.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amp.Workspace("example", {});
const exampleWorkspaceConfiguration = new aws.amp.WorkspaceConfiguration("example", {
limitsPerLabelSets: [
{
limits: {
maxSeries: 100000,
},
labelSet: {
env: "dev",
},
},
{
limits: {
maxSeries: 400000,
},
labelSet: {
env: "prod",
},
},
],
workspaceId: example.id,
retentionPeriodInDays: 60,
});
import pulumi
import pulumi_aws as aws
example = aws.amp.Workspace("example")
example_workspace_configuration = aws.amp.WorkspaceConfiguration("example",
limits_per_label_sets=[
{
"limits": {
"max_series": 100000,
},
"label_set": {
"env": "dev",
},
},
{
"limits": {
"max_series": 400000,
},
"label_set": {
"env": "prod",
},
},
],
workspace_id=example.id,
retention_period_in_days=60)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amp.Workspace("example");
var exampleWorkspaceConfiguration = new Aws.Amp.WorkspaceConfiguration("example", new()
{
LimitsPerLabelSets = new[]
{
new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetArgs
{
Limits = new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs
{
MaxSeries = 100000,
},
LabelSet =
{
{ "env", "dev" },
},
},
new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetArgs
{
Limits = new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs
{
MaxSeries = 400000,
},
LabelSet =
{
{ "env", "prod" },
},
},
},
WorkspaceId = example.Id,
RetentionPeriodInDays = 60,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := amp.NewWorkspace(ctx, "example", nil)
if err != nil {
return err
}
_, err = amp.NewWorkspaceConfiguration(ctx, "example", &.WorkspaceConfigurationArgs{
LimitsPerLabelSets: amp.WorkspaceConfigurationLimitsPerLabelSetArray{
&.WorkspaceConfigurationLimitsPerLabelSetArgs{
Limits: &.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs{
MaxSeries: pulumi.Int(100000),
},
LabelSet: pulumi.StringMap{
"env": pulumi.String("dev"),
},
},
&.WorkspaceConfigurationLimitsPerLabelSetArgs{
Limits: &.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs{
MaxSeries: pulumi.Int(400000),
},
LabelSet: pulumi.StringMap{
"env": pulumi.String("prod"),
},
},
},
WorkspaceId: example.ID().ToIDOutput().ToStringOutput(),
RetentionPeriodInDays: pulumi.Int(60),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amp_workspace" "example" {
}
resource "aws_amp_workspaceconfiguration" "example" {
limits_per_label_sets {
limits = {
max_series = 100000
}
label_set = {
"env" = "dev"
}
}
limits_per_label_sets {
limits = {
max_series = 400000
}
label_set = {
"env" = "prod"
}
}
workspace_id = aws_amp_workspace.example.id
retention_period_in_days = 60
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.Workspace;
import com.pulumi.aws.amp.WorkspaceConfiguration;
import com.pulumi.aws.amp.WorkspaceConfigurationArgs;
import com.pulumi.aws.amp.inputs.WorkspaceConfigurationLimitsPerLabelSetArgs;
import com.pulumi.aws.amp.inputs.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workspace("example");
var exampleWorkspaceConfiguration = new WorkspaceConfiguration("exampleWorkspaceConfiguration", WorkspaceConfigurationArgs.builder()
.limitsPerLabelSets(
WorkspaceConfigurationLimitsPerLabelSetArgs.builder()
.limits(WorkspaceConfigurationLimitsPerLabelSetLimitsArgs.builder()
.maxSeries(100000)
.build())
.labelSet(Map.of("env", "dev"))
.build(),
WorkspaceConfigurationLimitsPerLabelSetArgs.builder()
.limits(WorkspaceConfigurationLimitsPerLabelSetLimitsArgs.builder()
.maxSeries(400000)
.build())
.labelSet(Map.of("env", "prod"))
.build())
.workspaceId(example.id())
.retentionPeriodInDays(60)
.build());
}
}
resources:
example:
type: aws:amp:Workspace
exampleWorkspaceConfiguration:
type: aws:amp:WorkspaceConfiguration
name: example
properties:
limitsPerLabelSets:
- limits:
maxSeries: 100000
labelSet:
env: dev
- limits:
maxSeries: 400000
labelSet:
env: prod
workspaceId: ${example.id}
retentionPeriodInDays: 60
Setting up default bucket
The default bucket limit is the maximum number of active time series that can be ingested in the workspace, counting only time series that don’t match a defined label set.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amp.Workspace("example", {});
const exampleWorkspaceConfiguration = new aws.amp.WorkspaceConfiguration("example", {
limitsPerLabelSets: [{
limits: {
maxSeries: 50000,
},
labelSet: {},
}],
workspaceId: example.id,
});
import pulumi
import pulumi_aws as aws
example = aws.amp.Workspace("example")
example_workspace_configuration = aws.amp.WorkspaceConfiguration("example",
limits_per_label_sets=[{
"limits": {
"max_series": 50000,
},
"label_set": {},
}],
workspace_id=example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amp.Workspace("example");
var exampleWorkspaceConfiguration = new Aws.Amp.WorkspaceConfiguration("example", new()
{
LimitsPerLabelSets = new[]
{
new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetArgs
{
Limits = new Aws.Amp.Inputs.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs
{
MaxSeries = 50000,
},
LabelSet = null,
},
},
WorkspaceId = example.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := amp.NewWorkspace(ctx, "example", nil)
if err != nil {
return err
}
_, err = amp.NewWorkspaceConfiguration(ctx, "example", &.WorkspaceConfigurationArgs{
LimitsPerLabelSets: amp.WorkspaceConfigurationLimitsPerLabelSetArray{
&.WorkspaceConfigurationLimitsPerLabelSetArgs{
Limits: &.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs{
MaxSeries: pulumi.Int(50000),
},
LabelSet: pulumi.StringMap{},
},
},
WorkspaceId: example.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amp_workspace" "example" {
}
resource "aws_amp_workspaceconfiguration" "example" {
limits_per_label_sets {
limits = {
max_series = 50000
}
label_set = {}
}
workspace_id = aws_amp_workspace.example.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.Workspace;
import com.pulumi.aws.amp.WorkspaceConfiguration;
import com.pulumi.aws.amp.WorkspaceConfigurationArgs;
import com.pulumi.aws.amp.inputs.WorkspaceConfigurationLimitsPerLabelSetArgs;
import com.pulumi.aws.amp.inputs.WorkspaceConfigurationLimitsPerLabelSetLimitsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workspace("example");
var exampleWorkspaceConfiguration = new WorkspaceConfiguration("exampleWorkspaceConfiguration", WorkspaceConfigurationArgs.builder()
.limitsPerLabelSets(WorkspaceConfigurationLimitsPerLabelSetArgs.builder()
.limits(WorkspaceConfigurationLimitsPerLabelSetLimitsArgs.builder()
.maxSeries(50000)
.build())
.labelSet(Map.ofEntries(
))
.build())
.workspaceId(example.id())
.build());
}
}
resources:
example:
type: aws:amp:Workspace
exampleWorkspaceConfiguration:
type: aws:amp:WorkspaceConfiguration
name: example
properties:
limitsPerLabelSets:
- limits:
maxSeries: 50000
labelSet: {}
workspaceId: ${example.id}
With out-of-order and rule query configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amp.Workspace("example", {});
const exampleWorkspaceConfiguration = new aws.amp.WorkspaceConfiguration("example", {
workspaceId: example.id,
retentionPeriodInDays: 30,
outOfOrderTimeWindowInSeconds: 120,
ruleQueryOffsetInSeconds: 300,
});
import pulumi
import pulumi_aws as aws
example = aws.amp.Workspace("example")
example_workspace_configuration = aws.amp.WorkspaceConfiguration("example",
workspace_id=example.id,
retention_period_in_days=30,
out_of_order_time_window_in_seconds=120,
rule_query_offset_in_seconds=300)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amp.Workspace("example");
var exampleWorkspaceConfiguration = new Aws.Amp.WorkspaceConfiguration("example", new()
{
WorkspaceId = example.Id,
RetentionPeriodInDays = 30,
OutOfOrderTimeWindowInSeconds = 120,
RuleQueryOffsetInSeconds = 300,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := amp.NewWorkspace(ctx, "example", nil)
if err != nil {
return err
}
_, err = amp.NewWorkspaceConfiguration(ctx, "example", &.WorkspaceConfigurationArgs{
WorkspaceId: example.ID().ToIDOutput().ToStringOutput(),
RetentionPeriodInDays: pulumi.Int(30),
OutOfOrderTimeWindowInSeconds: pulumi.Int(120),
RuleQueryOffsetInSeconds: pulumi.Int(300),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amp_workspace" "example" {
}
resource "aws_amp_workspaceconfiguration" "example" {
workspace_id = aws_amp_workspace.example.id
retention_period_in_days = 30
out_of_order_time_window_in_seconds = 120
rule_query_offset_in_seconds = 300
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.Workspace;
import com.pulumi.aws.amp.WorkspaceConfiguration;
import com.pulumi.aws.amp.WorkspaceConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workspace("example");
var exampleWorkspaceConfiguration = new WorkspaceConfiguration("exampleWorkspaceConfiguration", WorkspaceConfigurationArgs.builder()
.workspaceId(example.id())
.retentionPeriodInDays(30)
.outOfOrderTimeWindowInSeconds(120)
.ruleQueryOffsetInSeconds(300)
.build());
}
}
resources:
example:
type: aws:amp:Workspace
exampleWorkspaceConfiguration:
type: aws:amp:WorkspaceConfiguration
name: example
properties:
workspaceId: ${example.id}
retentionPeriodInDays: 30
outOfOrderTimeWindowInSeconds: 120
ruleQueryOffsetInSeconds: 300
Import
Using pulumi import, import AMP (Managed Prometheus) Workspace Configuration using the workspaceId. For example
$ pulumi import aws:amp/workspaceConfiguration:WorkspaceConfiguration example ws-12345678-abcd-1234-abcd-123456789012
Constructors
- WorkspaceConfiguration(String name, {WorkspaceConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new WorkspaceConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this WorkspaceConfiguration. The set of arguments for WorkspaceConfiguration.optionsResource options controlling this resource's behavior. - WorkspaceConfiguration.reference(String urn)
- Creates a typed reference to an existing WorkspaceConfiguration resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
limitsPerLabelSets
↔ Output<
List< WorkspaceConfigurationLimitsPerLabelSet> ?> -
Configuration block for setting limits on metrics with specific label sets. Detailed below.
latefinal
-
outOfOrderTimeWindowInSeconds
↔ Output<
int> -
Time window in seconds for accepting out-of-order samples. Must be between 0 and 600 seconds.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
retentionPeriodInDays
↔ Output<
int> -
Number of days to retain metric data in the workspace.
latefinal
-
ruleQueryOffsetInSeconds
↔ Output<
int> -
Query offset in seconds for rule evaluation. Must be between 0 and 86400 seconds.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeouts
↔ Output<
WorkspaceConfigurationTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
workspaceId
↔ Output<
String> -
ID of the workspace to configure.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {WorkspaceConfigurationState? state, CustomResourceOptions? options}) → WorkspaceConfiguration -
Gets an existing WorkspaceConfiguration resource's state with the given
nameandid.