@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
186 lines (185 loc) • 7.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages an Amazon Managed Service for Prometheus (AMP) Workspace.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.amp.Workspace("example", {
* alias: "example",
* tags: {
* Environment: "production",
* },
* });
* ```
*
* ### CloudWatch Logging
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudwatch.LogGroup("example", {name: "example"});
* const exampleWorkspace = new aws.amp.Workspace("example", {loggingConfiguration: {
* logGroupArn: pulumi.interpolate`${example.arn}:*`,
* }});
* ```
*
* ### AWS KMS Customer Managed Keys (CMK)
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const exampleKey = new aws.kms.Key("example", {
* description: "example",
* deletionWindowInDays: 7,
* });
* const example = new aws.amp.Workspace("example", {
* alias: "example",
* kmsKeyArn: exampleKey.arn,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import AMP Workspaces using the identifier. For example:
*
* ```sh
* $ pulumi import aws:amp/workspace:Workspace demo ws-C6DCB907-F2D7-4D96-957B-66691F865D8B
* ```
*/
export declare class Workspace extends pulumi.CustomResource {
/**
* Get an existing Workspace resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkspaceState, opts?: pulumi.CustomResourceOptions): Workspace;
/**
* Returns true if the given object is an instance of Workspace. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Workspace;
/**
* The alias of the prometheus workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html).
*/
readonly alias: pulumi.Output<string | undefined>;
/**
* Amazon Resource Name (ARN) of the workspace.
*/
readonly arn: pulumi.Output<string>;
/**
* The ARN for the KMS encryption key. If this argument is not provided, then the AWS owned encryption key will be used to encrypt the data in the workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html)
*/
readonly kmsKeyArn: pulumi.Output<string | undefined>;
/**
* Logging configuration for the workspace. See Logging Configuration below for details.
*/
readonly loggingConfiguration: pulumi.Output<outputs.amp.WorkspaceLoggingConfiguration | undefined>;
/**
* Prometheus endpoint available for this workspace.
*/
readonly prometheusEndpoint: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Workspace resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: WorkspaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Workspace resources.
*/
export interface WorkspaceState {
/**
* The alias of the prometheus workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html).
*/
alias?: pulumi.Input<string>;
/**
* Amazon Resource Name (ARN) of the workspace.
*/
arn?: pulumi.Input<string>;
/**
* The ARN for the KMS encryption key. If this argument is not provided, then the AWS owned encryption key will be used to encrypt the data in the workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html)
*/
kmsKeyArn?: pulumi.Input<string>;
/**
* Logging configuration for the workspace. See Logging Configuration below for details.
*/
loggingConfiguration?: pulumi.Input<inputs.amp.WorkspaceLoggingConfiguration>;
/**
* Prometheus endpoint available for this workspace.
*/
prometheusEndpoint?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Workspace resource.
*/
export interface WorkspaceArgs {
/**
* The alias of the prometheus workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html).
*/
alias?: pulumi.Input<string>;
/**
* The ARN for the KMS encryption key. If this argument is not provided, then the AWS owned encryption key will be used to encrypt the data in the workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html)
*/
kmsKeyArn?: pulumi.Input<string>;
/**
* Logging configuration for the workspace. See Logging Configuration below for details.
*/
loggingConfiguration?: pulumi.Input<inputs.amp.WorkspaceLoggingConfiguration>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}