Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. aps
  5. Workspace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.aps.Workspace

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::APS::Workspace

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var apsWorkspace = new AwsNative.Aps.Workspace("apsWorkspace", new()
    {
        Alias = "TestWorkspace",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "BusinessPurpose",
                Value = "LoadTesting",
            },
        },
    });

});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/aps"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aps.NewWorkspace(ctx, "apsWorkspace", &aps.WorkspaceArgs{
			Alias: pulumi.String("TestWorkspace"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("BusinessPurpose"),
					Value: pulumi.String("LoadTesting"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const apsWorkspace = new aws_native.aps.Workspace("apsWorkspace", {
    alias: "TestWorkspace",
    tags: [{
        key: "BusinessPurpose",
        value: "LoadTesting",
    }],
});

    import pulumi
import pulumi_aws_native as aws_native

aps_workspace = aws_native.aps.Workspace("apsWorkspace",
    alias="TestWorkspace",
    tags=[{
        "key": "BusinessPurpose",
        "value": "LoadTesting",
    }])

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var apsWorkspace = new AwsNative.Aps.Workspace("apsWorkspace", new()
    {
        Alias = "TestWorkspace",
        LoggingConfiguration = new AwsNative.Aps.Inputs.WorkspaceLoggingConfigurationArgs
        {
            LogGroupArn = "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
        },
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "BusinessPurpose",
                Value = "LoadTesting",
            },
        },
    });

});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/aps"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aps.NewWorkspace(ctx, "apsWorkspace", &aps.WorkspaceArgs{
			Alias: pulumi.String("TestWorkspace"),
			LoggingConfiguration: &aps.WorkspaceLoggingConfigurationArgs{
				LogGroupArn: pulumi.String("arn:aws:logs:{region}:{account}:log-group:test-log-group:*"),
			},
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("BusinessPurpose"),
					Value: pulumi.String("LoadTesting"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const apsWorkspace = new aws_native.aps.Workspace("apsWorkspace", {
    alias: "TestWorkspace",
    loggingConfiguration: {
        logGroupArn: "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
    },
    tags: [{
        key: "BusinessPurpose",
        value: "LoadTesting",
    }],
});

    import pulumi
import pulumi_aws_native as aws_native

aps_workspace = aws_native.aps.Workspace("apsWorkspace",
    alias="TestWorkspace",
    logging_configuration={
        "log_group_arn": "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
    },
    tags=[{
        "key": "BusinessPurpose",
        "value": "LoadTesting",
    }])

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var apsWorkspace = new AwsNative.Aps.Workspace("apsWorkspace", new()
    {
        Alias = "TestWorkspace",
        LoggingConfiguration = new AwsNative.Aps.Inputs.WorkspaceLoggingConfigurationArgs
        {
            LogGroupArn = "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
        },
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "BusinessPurpose",
                Value = "LoadTesting",
            },
        },
    });

});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/aps"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aps.NewWorkspace(ctx, "apsWorkspace", &aps.WorkspaceArgs{
			Alias: pulumi.String("TestWorkspace"),
			LoggingConfiguration: &aps.WorkspaceLoggingConfigurationArgs{
				LogGroupArn: pulumi.String("arn:aws:logs:{region}:{account}:log-group:test-log-group:*"),
			},
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("BusinessPurpose"),
					Value: pulumi.String("LoadTesting"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const apsWorkspace = new aws_native.aps.Workspace("apsWorkspace", {
    alias: "TestWorkspace",
    loggingConfiguration: {
        logGroupArn: "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
    },
    tags: [{
        key: "BusinessPurpose",
        value: "LoadTesting",
    }],
});

    import pulumi
import pulumi_aws_native as aws_native

aps_workspace = aws_native.aps.Workspace("apsWorkspace",
    alias="TestWorkspace",
    logging_configuration={
        "log_group_arn": "arn:aws:logs:{region}:{account}:log-group:test-log-group:*",
    },
    tags=[{
        "key": "BusinessPurpose",
        "value": "LoadTesting",
    }])

    Coming soon!

    Create Workspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workspace(name: string, args?: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
def Workspace(resource_name: str,
              args: Optional[WorkspaceArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              alert_manager_definition: Optional[str] = None,
              alias: Optional[str] = None,
              kms_key_arn: Optional[str] = None,
              logging_configuration: Optional[WorkspaceLoggingConfigurationArgs] = None,
              query_logging_configuration: Optional[WorkspaceQueryLoggingConfigurationArgs] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              workspace_configuration: Optional[WorkspaceConfigurationArgs] = None)
    func NewWorkspace(ctx *Context, name string, args *WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs? args = null, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)

    type: aws-native:aps:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Workspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Workspace resource accepts the following input properties:

    AlertManagerDefinition string
    The AMP Workspace alert manager definition data
    Alias string
    AMP Workspace alias.
    KmsKeyArn string
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    LoggingConfiguration Pulumi.AwsNative.Aps.Inputs.WorkspaceLoggingConfiguration

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    QueryLoggingConfiguration Pulumi.AwsNative.Aps.Inputs.WorkspaceQueryLoggingConfiguration
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    WorkspaceConfiguration Pulumi.AwsNative.Aps.Inputs.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.
    AlertManagerDefinition string
    The AMP Workspace alert manager definition data
    Alias string
    AMP Workspace alias.
    KmsKeyArn string
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    LoggingConfiguration WorkspaceLoggingConfigurationArgs

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    QueryLoggingConfiguration WorkspaceQueryLoggingConfigurationArgs
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    WorkspaceConfiguration WorkspaceConfigurationArgs
    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.
    alertManagerDefinition String
    The AMP Workspace alert manager definition data
    alias String
    AMP Workspace alias.
    kmsKeyArn String
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    loggingConfiguration WorkspaceLoggingConfiguration

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    queryLoggingConfiguration WorkspaceQueryLoggingConfiguration
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    workspaceConfiguration 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.
    alertManagerDefinition string
    The AMP Workspace alert manager definition data
    alias string
    AMP Workspace alias.
    kmsKeyArn string
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    loggingConfiguration WorkspaceLoggingConfiguration

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    queryLoggingConfiguration WorkspaceQueryLoggingConfiguration
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    workspaceConfiguration 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.
    alert_manager_definition str
    The AMP Workspace alert manager definition data
    alias str
    AMP Workspace alias.
    kms_key_arn str
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    logging_configuration WorkspaceLoggingConfigurationArgs

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    query_logging_configuration WorkspaceQueryLoggingConfigurationArgs
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    workspace_configuration WorkspaceConfigurationArgs
    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.
    alertManagerDefinition String
    The AMP Workspace alert manager definition data
    alias String
    AMP Workspace alias.
    kmsKeyArn String
    KMS Key ARN used to encrypt and decrypt AMP workspace data.
    loggingConfiguration Property Map

    Contains information about the current rules and alerting logging configuration for the workspace.

    These logging configurations are only for rules and alerting logs.

    queryLoggingConfiguration Property Map
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    workspaceConfiguration Property Map
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

    Arn string
    Workspace arn.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrometheusEndpoint string
    AMP Workspace prometheus endpoint
    WorkspaceId string
    Required to identify a specific APS Workspace.
    Arn string
    Workspace arn.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrometheusEndpoint string
    AMP Workspace prometheus endpoint
    WorkspaceId string
    Required to identify a specific APS Workspace.
    arn String
    Workspace arn.
    id String
    The provider-assigned unique ID for this managed resource.
    prometheusEndpoint String
    AMP Workspace prometheus endpoint
    workspaceId String
    Required to identify a specific APS Workspace.
    arn string
    Workspace arn.
    id string
    The provider-assigned unique ID for this managed resource.
    prometheusEndpoint string
    AMP Workspace prometheus endpoint
    workspaceId string
    Required to identify a specific APS Workspace.
    arn str
    Workspace arn.
    id str
    The provider-assigned unique ID for this managed resource.
    prometheus_endpoint str
    AMP Workspace prometheus endpoint
    workspace_id str
    Required to identify a specific APS Workspace.
    arn String
    Workspace arn.
    id String
    The provider-assigned unique ID for this managed resource.
    prometheusEndpoint String
    AMP Workspace prometheus endpoint
    workspaceId String
    Required to identify a specific APS Workspace.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkspaceCloudWatchLogDestination, WorkspaceCloudWatchLogDestinationArgs

    LogGroupArn string
    The ARN of the CloudWatch Logs log group
    LogGroupArn string
    The ARN of the CloudWatch Logs log group
    logGroupArn String
    The ARN of the CloudWatch Logs log group
    logGroupArn string
    The ARN of the CloudWatch Logs log group
    log_group_arn str
    The ARN of the CloudWatch Logs log group
    logGroupArn String
    The ARN of the CloudWatch Logs log group

    WorkspaceConfiguration, WorkspaceConfigurationArgs

    LimitsPerLabelSets List<Pulumi.AwsNative.Aps.Inputs.WorkspaceLimitsPerLabelSet>
    An array of label set and associated limits
    RetentionPeriodInDays int
    How many days that metrics are retained in the workspace
    LimitsPerLabelSets []WorkspaceLimitsPerLabelSet
    An array of label set and associated limits
    RetentionPeriodInDays int
    How many days that metrics are retained in the workspace
    limitsPerLabelSets List<WorkspaceLimitsPerLabelSet>
    An array of label set and associated limits
    retentionPeriodInDays Integer
    How many days that metrics are retained in the workspace
    limitsPerLabelSets WorkspaceLimitsPerLabelSet[]
    An array of label set and associated limits
    retentionPeriodInDays number
    How many days that metrics are retained in the workspace
    limits_per_label_sets Sequence[WorkspaceLimitsPerLabelSet]
    An array of label set and associated limits
    retention_period_in_days int
    How many days that metrics are retained in the workspace
    limitsPerLabelSets List<Property Map>
    An array of label set and associated limits
    retentionPeriodInDays Number
    How many days that metrics are retained in the workspace

    WorkspaceLabel, WorkspaceLabelArgs

    Name string
    Name of the label
    Value string
    Value of the label
    Name string
    Name of the label
    Value string
    Value of the label
    name String
    Name of the label
    value String
    Value of the label
    name string
    Name of the label
    value string
    Value of the label
    name str
    Name of the label
    value str
    Value of the label
    name String
    Name of the label
    value String
    Value of the label

    WorkspaceLimitsPerLabelSet, WorkspaceLimitsPerLabelSetArgs

    LabelSet List<Pulumi.AwsNative.Aps.Inputs.WorkspaceLabel>
    An array of series labels
    Limits Pulumi.AwsNative.Aps.Inputs.WorkspaceLimitsPerLabelSetEntry
    This structure contains the information about the limits that apply to time series that match this label set.
    LabelSet []WorkspaceLabel
    An array of series labels
    Limits WorkspaceLimitsPerLabelSetEntry
    This structure contains the information about the limits that apply to time series that match this label set.
    labelSet List<WorkspaceLabel>
    An array of series labels
    limits WorkspaceLimitsPerLabelSetEntry
    This structure contains the information about the limits that apply to time series that match this label set.
    labelSet WorkspaceLabel[]
    An array of series labels
    limits WorkspaceLimitsPerLabelSetEntry
    This structure contains the information about the limits that apply to time series that match this label set.
    label_set Sequence[WorkspaceLabel]
    An array of series labels
    limits WorkspaceLimitsPerLabelSetEntry
    This structure contains the information about the limits that apply to time series that match this label set.
    labelSet List<Property Map>
    An array of series labels
    limits Property Map
    This structure contains the information about the limits that apply to time series that match this label set.

    WorkspaceLimitsPerLabelSetEntry, WorkspaceLimitsPerLabelSetEntryArgs

    MaxSeries int
    The maximum number of active series that can be ingested for this label set
    MaxSeries int
    The maximum number of active series that can be ingested for this label set
    maxSeries Integer
    The maximum number of active series that can be ingested for this label set
    maxSeries number
    The maximum number of active series that can be ingested for this label set
    max_series int
    The maximum number of active series that can be ingested for this label set
    maxSeries Number
    The maximum number of active series that can be ingested for this label set

    WorkspaceLoggingConfiguration, WorkspaceLoggingConfigurationArgs

    LogGroupArn string
    CloudWatch log group ARN
    LogGroupArn string
    CloudWatch log group ARN
    logGroupArn String
    CloudWatch log group ARN
    logGroupArn string
    CloudWatch log group ARN
    log_group_arn str
    CloudWatch log group ARN
    logGroupArn String
    CloudWatch log group ARN

    WorkspaceLoggingDestination, WorkspaceLoggingDestinationArgs

    CloudWatchLogs Pulumi.AwsNative.Aps.Inputs.WorkspaceCloudWatchLogDestination
    Configuration details for logging to CloudWatch Logs.
    Filters Pulumi.AwsNative.Aps.Inputs.WorkspaceLoggingFilter
    Filtering criteria that determine which queries are logged.
    CloudWatchLogs WorkspaceCloudWatchLogDestination
    Configuration details for logging to CloudWatch Logs.
    Filters WorkspaceLoggingFilter
    Filtering criteria that determine which queries are logged.
    cloudWatchLogs WorkspaceCloudWatchLogDestination
    Configuration details for logging to CloudWatch Logs.
    filters WorkspaceLoggingFilter
    Filtering criteria that determine which queries are logged.
    cloudWatchLogs WorkspaceCloudWatchLogDestination
    Configuration details for logging to CloudWatch Logs.
    filters WorkspaceLoggingFilter
    Filtering criteria that determine which queries are logged.
    cloud_watch_logs WorkspaceCloudWatchLogDestination
    Configuration details for logging to CloudWatch Logs.
    filters WorkspaceLoggingFilter
    Filtering criteria that determine which queries are logged.
    cloudWatchLogs Property Map
    Configuration details for logging to CloudWatch Logs.
    filters Property Map
    Filtering criteria that determine which queries are logged.

    WorkspaceLoggingFilter, WorkspaceLoggingFilterArgs

    QspThreshold int
    Query logs with QSP above this limit are vended
    QspThreshold int
    Query logs with QSP above this limit are vended
    qspThreshold Integer
    Query logs with QSP above this limit are vended
    qspThreshold number
    Query logs with QSP above this limit are vended
    qsp_threshold int
    Query logs with QSP above this limit are vended
    qspThreshold Number
    Query logs with QSP above this limit are vended

    WorkspaceQueryLoggingConfiguration, WorkspaceQueryLoggingConfigurationArgs

    Destinations List<Pulumi.AwsNative.Aps.Inputs.WorkspaceLoggingDestination>
    The destinations configuration for query logging
    Destinations []WorkspaceLoggingDestination
    The destinations configuration for query logging
    destinations List<WorkspaceLoggingDestination>
    The destinations configuration for query logging
    destinations WorkspaceLoggingDestination[]
    The destinations configuration for query logging
    destinations Sequence[WorkspaceLoggingDestination]
    The destinations configuration for query logging
    destinations List<Property Map>
    The destinations configuration for query logging

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native