We recommend new projects start with resources from the AWS provider.
aws-native.aps.Workspace
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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,
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:
- Alert
Manager stringDefinition - The AMP Workspace alert manager definition data
- Alias string
- AMP Workspace alias.
- Kms
Key stringArn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- Logging
Configuration Pulumi.Aws Native. Aps. Inputs. Workspace Logging Configuration - Contains information about the logging configuration for the workspace.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Workspace
Configuration Pulumi.Aws Native. Aps. Inputs. Workspace Configuration - 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 stringDefinition - The AMP Workspace alert manager definition data
- Alias string
- AMP Workspace alias.
- Kms
Key stringArn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- Logging
Configuration WorkspaceLogging Configuration Args - Contains information about the logging configuration for the workspace.
- Tag
Args - An array of key-value pairs to apply to this resource.
- Workspace
Configuration WorkspaceConfiguration Args - 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 StringDefinition - The AMP Workspace alert manager definition data
- alias String
- AMP Workspace alias.
- kms
Key StringArn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- logging
Configuration WorkspaceLogging Configuration - Contains information about the logging configuration for the workspace.
- List<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.
- alert
Manager stringDefinition - The AMP Workspace alert manager definition data
- alias string
- AMP Workspace alias.
- kms
Key stringArn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- logging
Configuration WorkspaceLogging Configuration - Contains information about the logging configuration for the workspace.
- 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.
- alert_
manager_ strdefinition - The AMP Workspace alert manager definition data
- alias str
- AMP Workspace alias.
- kms_
key_ strarn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- logging_
configuration WorkspaceLogging Configuration Args - Contains information about the logging configuration for the workspace.
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- workspace_
configuration WorkspaceConfiguration Args - 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 StringDefinition - The AMP Workspace alert manager definition data
- alias String
- AMP Workspace alias.
- kms
Key StringArn - KMS Key ARN used to encrypt and decrypt AMP workspace data.
- logging
Configuration Property Map - Contains information about the logging configuration for the workspace.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- workspace
Configuration 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.
- Prometheus
Endpoint string - AMP Workspace prometheus endpoint
- Workspace
Id string - Required to identify a specific APS Workspace.
- Arn string
- Workspace arn.
- Id string
- The provider-assigned unique ID for this managed resource.
- Prometheus
Endpoint string - AMP Workspace prometheus endpoint
- Workspace
Id string - Required to identify a specific APS Workspace.
- arn String
- Workspace arn.
- id String
- The provider-assigned unique ID for this managed resource.
- prometheus
Endpoint String - AMP Workspace prometheus endpoint
- workspace
Id String - Required to identify a specific APS Workspace.
- arn string
- Workspace arn.
- id string
- The provider-assigned unique ID for this managed resource.
- prometheus
Endpoint string - AMP Workspace prometheus endpoint
- workspace
Id 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.
- prometheus
Endpoint String - AMP Workspace prometheus endpoint
- workspace
Id String - Required to identify a specific APS Workspace.
Supporting Types
Tag, TagArgs
WorkspaceConfiguration, WorkspaceConfigurationArgs
- Limits
Per List<Pulumi.Label Sets Aws Native. Aps. Inputs. Workspace Limits Per Label Set> - An array of label set and associated limits
- Retention
Period intIn Days - How many days that metrics are retained in the workspace
- Limits
Per []WorkspaceLabel Sets Limits Per Label Set - An array of label set and associated limits
- Retention
Period intIn Days - How many days that metrics are retained in the workspace
- limits
Per List<WorkspaceLabel Sets Limits Per Label Set> - An array of label set and associated limits
- retention
Period IntegerIn Days - How many days that metrics are retained in the workspace
- limits
Per WorkspaceLabel Sets Limits Per Label Set[] - An array of label set and associated limits
- retention
Period numberIn Days - How many days that metrics are retained in the workspace
- limits_
per_ Sequence[Workspacelabel_ sets Limits Per Label Set] - An array of label set and associated limits
- retention_
period_ intin_ days - How many days that metrics are retained in the workspace
- limits
Per List<Property Map>Label Sets - An array of label set and associated limits
- retention
Period NumberIn Days - How many days that metrics are retained in the workspace
WorkspaceLabel, WorkspaceLabelArgs
WorkspaceLimitsPerLabelSet, WorkspaceLimitsPerLabelSetArgs
- Label
Set List<Pulumi.Aws Native. Aps. Inputs. Workspace Label> - An array of series labels
- Limits
Pulumi.
Aws Native. Aps. Inputs. Workspace Limits Per Label Set Entry - This structure contains the information about the limits that apply to time series that match this label set.
- Label
Set []WorkspaceLabel - An array of series labels
- Limits
Workspace
Limits Per Label Set Entry - This structure contains the information about the limits that apply to time series that match this label set.
- label
Set List<WorkspaceLabel> - An array of series labels
- limits
Workspace
Limits Per Label Set Entry - This structure contains the information about the limits that apply to time series that match this label set.
- label
Set WorkspaceLabel[] - An array of series labels
- limits
Workspace
Limits Per Label Set Entry - 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
Workspace
Limits Per Label Set Entry - This structure contains the information about the limits that apply to time series that match this label set.
- label
Set 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
- Max
Series int - 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
- max
Series Integer - The maximum number of active series that can be ingested for this label set
- max
Series 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
- max
Series Number - The maximum number of active series that can be ingested for this label set
WorkspaceLoggingConfiguration, WorkspaceLoggingConfigurationArgs
- Log
Group stringArn - CloudWatch log group ARN
- Log
Group stringArn - CloudWatch log group ARN
- log
Group StringArn - CloudWatch log group ARN
- log
Group stringArn - CloudWatch log group ARN
- log_
group_ strarn - CloudWatch log group ARN
- log
Group StringArn - CloudWatch log group ARN
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.