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. getWorkspace

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.getWorkspace

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

    Using getWorkspace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
    def get_workspace(arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

    > Note: This function is named LookupWorkspace in the Go SDK.

    public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:aps:getWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Workspace arn.
    Arn string
    Workspace arn.
    arn String
    Workspace arn.
    arn string
    Workspace arn.
    arn str
    Workspace arn.
    arn String
    Workspace arn.

    getWorkspace Result

    The following output properties are available:

    AlertManagerDefinition string
    The AMP Workspace alert manager definition data
    Alias string
    AMP Workspace alias.
    Arn string
    Workspace arn.
    LoggingConfiguration Pulumi.AwsNative.Aps.Outputs.WorkspaceLoggingConfiguration

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

    These logging configurations are only for rules and alerting logs.

    PrometheusEndpoint string
    AMP Workspace prometheus endpoint
    QueryLoggingConfiguration Pulumi.AwsNative.Aps.Outputs.WorkspaceQueryLoggingConfiguration
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    WorkspaceConfiguration Pulumi.AwsNative.Aps.Outputs.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.
    WorkspaceId string
    Required to identify a specific APS Workspace.
    AlertManagerDefinition string
    The AMP Workspace alert manager definition data
    Alias string
    AMP Workspace alias.
    Arn string
    Workspace arn.
    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.

    PrometheusEndpoint string
    AMP Workspace prometheus endpoint
    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.
    WorkspaceId string
    Required to identify a specific APS Workspace.
    alertManagerDefinition String
    The AMP Workspace alert manager definition data
    alias String
    AMP Workspace alias.
    arn String
    Workspace arn.
    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.

    prometheusEndpoint String
    AMP Workspace prometheus endpoint
    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.
    workspaceId String
    Required to identify a specific APS Workspace.
    alertManagerDefinition string
    The AMP Workspace alert manager definition data
    alias string
    AMP Workspace alias.
    arn string
    Workspace arn.
    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.

    prometheusEndpoint string
    AMP Workspace prometheus endpoint
    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.
    workspaceId string
    Required to identify a specific APS Workspace.
    alert_manager_definition str
    The AMP Workspace alert manager definition data
    alias str
    AMP Workspace alias.
    arn str
    Workspace arn.
    logging_configuration WorkspaceLoggingConfiguration

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

    These logging configurations are only for rules and alerting logs.

    prometheus_endpoint str
    AMP Workspace prometheus endpoint
    query_logging_configuration WorkspaceQueryLoggingConfiguration
    The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    workspace_configuration 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.
    workspace_id str
    Required to identify a specific APS Workspace.
    alertManagerDefinition String
    The AMP Workspace alert manager definition data
    alias String
    AMP Workspace alias.
    arn String
    Workspace arn.
    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.

    prometheusEndpoint String
    AMP Workspace prometheus endpoint
    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.
    workspaceId String
    Required to identify a specific APS Workspace.

    Supporting Types

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

    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

    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

    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

    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

    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

    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

    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

    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

    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