UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

160 lines (159 loc) 4.44 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides an Amazon Managed Grafana workspace data source. * * ## Example Usage * * ### Basic configuration * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.grafana.getWorkspace({ * workspaceId: "g-2054c75a02", * }); * ``` */ export declare function getWorkspace(args: GetWorkspaceArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkspaceResult>; /** * A collection of arguments for invoking getWorkspace. */ export interface GetWorkspaceArgs { /** * 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?: string; /** * Tags assigned to the resource */ tags?: { [key: string]: string; }; /** * Grafana workspace ID. */ workspaceId: string; } /** * A collection of values returned by getWorkspace. */ export interface GetWorkspaceResult { /** * (Required) Type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`. If `ORGANIZATION` is specified, then `organizationalUnits` must also be present. */ readonly accountAccessType: string; /** * ARN of the Grafana workspace. */ readonly arn: string; /** * (Required) Authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both. */ readonly authenticationProviders: string[]; /** * Creation date of the Grafana workspace. */ readonly createdDate: string; /** * Data sources for the workspace. */ readonly dataSources: string[]; /** * Workspace description. */ readonly description: string; /** * Endpoint of the Grafana workspace. */ readonly endpoint: string; /** * Version of Grafana running on the workspace. */ readonly grafanaVersion: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * Last updated date of the Grafana workspace. */ readonly lastUpdatedDate: string; /** * Grafana workspace name. */ readonly name: string; /** * The notification destinations. */ readonly notificationDestinations: string[]; /** * The role name that the workspace uses to access resources through Amazon Organizations. */ readonly organizationRoleName: string; /** * The Amazon Organizations organizational units that the workspace is authorized to use data sources from. */ readonly organizationalUnits: string[]; /** * Permission type of the workspace. */ readonly permissionType: string; readonly region: string; /** * IAM role ARN that the workspace assumes. */ readonly roleArn: string; readonly samlConfigurationStatus: string; /** * AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace. */ readonly stackSetName: string; /** * Status of the Grafana workspace. */ readonly status: string; /** * Tags assigned to the resource */ readonly tags: { [key: string]: string; }; readonly workspaceId: string; } /** * Provides an Amazon Managed Grafana workspace data source. * * ## Example Usage * * ### Basic configuration * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.grafana.getWorkspace({ * workspaceId: "g-2054c75a02", * }); * ``` */ export declare function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkspaceResult>; /** * A collection of arguments for invoking getWorkspace. */ export interface GetWorkspaceOutputArgs { /** * 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>; /** * Tags assigned to the resource */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Grafana workspace ID. */ workspaceId: pulumi.Input<string>; }