AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.grafana.getWorkspace
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
Definition of AWS::Grafana::Workspace Resource Type
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(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(id: 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:grafana:getWorkspace
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- The id that uniquely identifies a Grafana workspace.
- Id string
- The id that uniquely identifies a Grafana workspace.
- id String
- The id that uniquely identifies a Grafana workspace.
- id string
- The id that uniquely identifies a Grafana workspace.
- id str
- The id that uniquely identifies a Grafana workspace.
- id String
- The id that uniquely identifies a Grafana workspace.
getWorkspace Result
The following output properties are available:
- Account
Access Pulumi.Type Aws Native. Grafana. Workspace Account Access Type - Authentication
Providers List<Pulumi.Aws Native. Grafana. Workspace Authentication Provider Types> - List of authentication providers to enable.
- Creation
Timestamp string - Timestamp when the workspace was created.
- Data
Sources List<Pulumi.Aws Native. Grafana. Workspace Data Source Type> - List of data sources on the service managed IAM role.
- Description string
- Description of a workspace.
- Endpoint string
- Endpoint for the Grafana workspace.
- string
- The version of Grafana to support in your workspace.
- Id string
- The id that uniquely identifies a Grafana workspace.
- Modification
Timestamp string - Timestamp when the workspace was last modified
- Name string
- The user friendly name of a workspace.
- Network
Access Pulumi.Control Aws Native. Grafana. Outputs. Workspace Network Access Control - Notification
Destinations List<Pulumi.Aws Native. Grafana. Workspace Notification Destination Type> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- Organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- Organizational
Units List<string> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- Permission
Type Pulumi.Aws Native. Grafana. Workspace Permission Type - Plugin
Admin boolEnabled - Allow workspace admins to install plugins
- Role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- Saml
Configuration Pulumi.Aws Native. Grafana. Outputs. Workspace Saml Configuration - Saml
Configuration Pulumi.Status Aws Native. Grafana. Workspace Saml Configuration Status - Sso
Client stringId - The client ID of the AWS SSO Managed Application.
- Stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- Status
Pulumi.
Aws Native. Grafana. Workspace Status - Vpc
Configuration Pulumi.Aws Native. Grafana. Outputs. Workspace Vpc Configuration
- Account
Access WorkspaceType Account Access Type - Authentication
Providers []WorkspaceAuthentication Provider Types - List of authentication providers to enable.
- Creation
Timestamp string - Timestamp when the workspace was created.
- Data
Sources []WorkspaceData Source Type - List of data sources on the service managed IAM role.
- Description string
- Description of a workspace.
- Endpoint string
- Endpoint for the Grafana workspace.
- string
- The version of Grafana to support in your workspace.
- Id string
- The id that uniquely identifies a Grafana workspace.
- Modification
Timestamp string - Timestamp when the workspace was last modified
- Name string
- The user friendly name of a workspace.
- Network
Access WorkspaceControl Network Access Control - Notification
Destinations []WorkspaceNotification Destination Type - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- Organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- Organizational
Units []string - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- Permission
Type WorkspacePermission Type - Plugin
Admin boolEnabled - Allow workspace admins to install plugins
- Role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- Saml
Configuration WorkspaceSaml Configuration - Saml
Configuration WorkspaceStatus Saml Configuration Status - Sso
Client stringId - The client ID of the AWS SSO Managed Application.
- Stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- Status
Workspace
Status - Vpc
Configuration WorkspaceVpc Configuration
- account
Access WorkspaceType Account Access Type - authentication
Providers List<WorkspaceAuthentication Provider Types> - List of authentication providers to enable.
- creation
Timestamp String - Timestamp when the workspace was created.
- data
Sources List<WorkspaceData Source Type> - List of data sources on the service managed IAM role.
- description String
- Description of a workspace.
- endpoint String
- Endpoint for the Grafana workspace.
- String
- The version of Grafana to support in your workspace.
- id String
- The id that uniquely identifies a Grafana workspace.
- modification
Timestamp String - Timestamp when the workspace was last modified
- name String
- The user friendly name of a workspace.
- network
Access WorkspaceControl Network Access Control - notification
Destinations List<WorkspaceNotification Destination Type> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role StringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units List<String> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- permission
Type WorkspacePermission Type - plugin
Admin BooleanEnabled - Allow workspace admins to install plugins
- role
Arn String - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration WorkspaceSaml Configuration - saml
Configuration WorkspaceStatus Saml Configuration Status - sso
Client StringId - The client ID of the AWS SSO Managed Application.
- stack
Set StringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- status
Workspace
Status - vpc
Configuration WorkspaceVpc Configuration
- account
Access WorkspaceType Account Access Type - authentication
Providers WorkspaceAuthentication Provider Types[] - List of authentication providers to enable.
- creation
Timestamp string - Timestamp when the workspace was created.
- data
Sources WorkspaceData Source Type[] - List of data sources on the service managed IAM role.
- description string
- Description of a workspace.
- endpoint string
- Endpoint for the Grafana workspace.
- string
- The version of Grafana to support in your workspace.
- id string
- The id that uniquely identifies a Grafana workspace.
- modification
Timestamp string - Timestamp when the workspace was last modified
- name string
- The user friendly name of a workspace.
- network
Access WorkspaceControl Network Access Control - notification
Destinations WorkspaceNotification Destination Type[] - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role stringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units string[] - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- permission
Type WorkspacePermission Type - plugin
Admin booleanEnabled - Allow workspace admins to install plugins
- role
Arn string - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration WorkspaceSaml Configuration - saml
Configuration WorkspaceStatus Saml Configuration Status - sso
Client stringId - The client ID of the AWS SSO Managed Application.
- stack
Set stringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- status
Workspace
Status - vpc
Configuration WorkspaceVpc Configuration
- account_
access_ Workspacetype Account Access Type - authentication_
providers Sequence[WorkspaceAuthentication Provider Types] - List of authentication providers to enable.
- creation_
timestamp str - Timestamp when the workspace was created.
- data_
sources Sequence[WorkspaceData Source Type] - List of data sources on the service managed IAM role.
- description str
- Description of a workspace.
- endpoint str
- Endpoint for the Grafana workspace.
- grafana_
version str - The version of Grafana to support in your workspace.
- id str
- The id that uniquely identifies a Grafana workspace.
- modification_
timestamp str - Timestamp when the workspace was last modified
- name str
- The user friendly name of a workspace.
- network_
access_ Workspacecontrol Network Access Control - notification_
destinations Sequence[WorkspaceNotification Destination Type] - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization_
role_ strname - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational_
units Sequence[str] - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- permission_
type WorkspacePermission Type - plugin_
admin_ boolenabled - Allow workspace admins to install plugins
- role_
arn str - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml_
configuration WorkspaceSaml Configuration - saml_
configuration_ Workspacestatus Saml Configuration Status - sso_
client_ strid - The client ID of the AWS SSO Managed Application.
- stack_
set_ strname - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- status
Workspace
Status - vpc_
configuration WorkspaceVpc Configuration
- account
Access "CURRENT_ACCOUNT" | "ORGANIZATION"Type - authentication
Providers List<"AWS_SSO" | "SAML"> - List of authentication providers to enable.
- creation
Timestamp String - Timestamp when the workspace was created.
- data
Sources List<"AMAZON_OPENSEARCH_SERVICE" | "CLOUDWATCH" | "PROMETHEUS" | "XRAY" | "TIMESTREAM" | "SITEWISE" | "ATHENA" | "REDSHIFT"> - List of data sources on the service managed IAM role.
- description String
- Description of a workspace.
- endpoint String
- Endpoint for the Grafana workspace.
- String
- The version of Grafana to support in your workspace.
- id String
- The id that uniquely identifies a Grafana workspace.
- modification
Timestamp String - Timestamp when the workspace was last modified
- name String
- The user friendly name of a workspace.
- network
Access Property MapControl - notification
Destinations List<"SNS"> - List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
- organization
Role StringName - The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
- organizational
Units List<String> - List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
- permission
Type "CUSTOMER_MANAGED" | "SERVICE_MANAGED" - plugin
Admin BooleanEnabled - Allow workspace admins to install plugins
- role
Arn String - IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
- saml
Configuration Property Map - saml
Configuration "CONFIGURED" | "NOT_CONFIGURED"Status - sso
Client StringId - The client ID of the AWS SSO Managed Application.
- stack
Set StringName - The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
- status "ACTIVE" | "CREATING" | "DELETING" | "FAILED" | "UPDATING" | "UPGRADING" | "VERSION_UPDATING" | "DELETION_FAILED" | "CREATION_FAILED" | "UPDATE_FAILED" | "UPGRADE_FAILED" | "LICENSE_REMOVAL_FAILED" | "VERSION_UPDATE_FAILED"
- vpc
Configuration Property Map
Supporting Types
WorkspaceAccountAccessType
WorkspaceAssertionAttributes
- Email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- Groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- Login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- Name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- Org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- Role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- Email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- Groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- Login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- Name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- Org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- Role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email String
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups String
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login String
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name String
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org String
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role String
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email string
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups string
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login string
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name string
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org string
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role string
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email str
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups str
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login str
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name str
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org str
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role str
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
- email String
- Name of the attribute within the SAML assert to use as the users email in Grafana.
- groups String
- Name of the attribute within the SAML assert to use as the users groups in Grafana.
- login String
- Name of the attribute within the SAML assert to use as the users login handle in Grafana.
- name String
- Name of the attribute within the SAML assert to use as the users name in Grafana.
- org String
- Name of the attribute within the SAML assert to use as the users organizations in Grafana.
- role String
- Name of the attribute within the SAML assert to use as the users roles in Grafana.
WorkspaceAuthenticationProviderTypes
WorkspaceDataSourceType
WorkspaceIdpMetadata
WorkspaceNetworkAccessControl
- Prefix
List List<string>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- Vpce
Ids List<string> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- Prefix
List []stringIds - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- Vpce
Ids []string - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List List<String>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids List<String> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List string[]Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids string[] - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix_
list_ Sequence[str]ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce_
ids Sequence[str] - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
- prefix
List List<String>Ids - The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace.
- vpce
Ids List<String> - The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace.
WorkspaceNotificationDestinationType
WorkspacePermissionType
WorkspaceRoleValues
WorkspaceSamlConfiguration
- Idp
Metadata Pulumi.Aws Native. Grafana. Inputs. Workspace Idp Metadata - Allowed
Organizations List<string> - List of SAML organizations allowed to access Grafana.
- Assertion
Attributes Pulumi.Aws Native. Grafana. Inputs. Workspace Assertion Attributes - Login
Validity doubleDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- Role
Values Pulumi.Aws Native. Grafana. Inputs. Workspace Role Values
- Idp
Metadata WorkspaceIdp Metadata - Allowed
Organizations []string - List of SAML organizations allowed to access Grafana.
- Assertion
Attributes WorkspaceAssertion Attributes - Login
Validity float64Duration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- Role
Values WorkspaceRole Values
- idp
Metadata WorkspaceIdp Metadata - allowed
Organizations List<String> - List of SAML organizations allowed to access Grafana.
- assertion
Attributes WorkspaceAssertion Attributes - login
Validity DoubleDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values WorkspaceRole Values
- idp
Metadata WorkspaceIdp Metadata - allowed
Organizations string[] - List of SAML organizations allowed to access Grafana.
- assertion
Attributes WorkspaceAssertion Attributes - login
Validity numberDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values WorkspaceRole Values
- idp_
metadata WorkspaceIdp Metadata - allowed_
organizations Sequence[str] - List of SAML organizations allowed to access Grafana.
- assertion_
attributes WorkspaceAssertion Attributes - login_
validity_ floatduration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role_
values WorkspaceRole Values
- idp
Metadata Property Map - allowed
Organizations List<String> - List of SAML organizations allowed to access Grafana.
- assertion
Attributes Property Map - login
Validity NumberDuration - The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
- role
Values Property Map
WorkspaceSamlConfigurationStatus
WorkspaceStatus
WorkspaceVpcConfiguration
- Security
Group List<string>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids List<string> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- Security
Group []stringIds - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- Subnet
Ids []string - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids List<String> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group string[]Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids string[] - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security_
group_ Sequence[str]ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet_
ids Sequence[str] - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
- security
Group List<String>Ids - The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
- subnet
Ids List<String> - The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi