WorkspaceState class

Input properties used for looking up and filtering Workspace resources.

Constructors

WorkspaceState({Input<String?>? accountAccessType, Input<String?>? arn, Input<List<String>?>? authenticationProviders, Input<String?>? configuration, Input<List<String>?>? dataSources, Input<String?>? description, Input<String?>? endpoint, Input<String?>? grafanaVersion, Input<String?>? kmsKeyId, Input<String?>? name, Input<WorkspaceNetworkAccessControl?>? networkAccessControl, Input<List<String>?>? notificationDestinations, Input<String?>? organizationRoleName, Input<List<String>?>? organizationalUnits, Input<String?>? permissionType, Input<String?>? region, Input<String?>? roleArn, Input<String?>? samlConfigurationStatus, Input<String?>? stackSetName, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<WorkspaceVpcConfiguration?>? vpcConfiguration})
Creates a new WorkspaceState. accountAccessType The type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizationalUnits must also be present. arn ARN of the Grafana workspace. authenticationProviders The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both. configuration The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace. dataSources The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, TWINMAKER, XRAY description The workspace description. endpoint The endpoint of the Grafana workspace. grafanaVersion Specifies the version of Grafana to support in the new workspace. Supported values are 9.4, 10.4 and 12.4. If not specified, defaults to the latest version. kmsKeyId The ARN of the AWS KMS key for encrypting workspace data. name The Grafana workspace name. networkAccessControl Configuration for network access to your workspace.See Network Access Control below. notificationDestinations The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS. organizationRoleName The role name that the workspace uses to access resources through Amazon Organizations. organizationalUnits The Amazon Organizations organizational units that the workspace is authorized to use data sources from. permissionType The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn The IAM role ARN that the workspace assumes. samlConfigurationStatus Optional. stackSetName The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace. tags Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. vpcConfiguration The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
const
WorkspaceState.fromMap(Map<String, dynamic> map)
factory

Properties

accountAccessType → Input<String?>?
The type of account access for the workspace. Valid values are CURRENT_ACCOUNT and ORGANIZATION. If ORGANIZATION is specified, then organizationalUnits must also be present.
final
arn → Input<String?>?
ARN of the Grafana workspace.
final
authenticationProviders → Input<List<String>?>?
The authentication providers for the workspace. Valid values are AWS_SSO, SAML, or both.
final
configuration → Input<String?>?
The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
final
dataSources → Input<List<String>?>?
The data sources for the workspace. Valid values are AMAZON_OPENSEARCH_SERVICE, ATHENA, CLOUDWATCH, PROMETHEUS, REDSHIFT, SITEWISE, TIMESTREAM, TWINMAKER, XRAY
final
description → Input<String?>?
The workspace description.
final
endpoint → Input<String?>?
The endpoint of the Grafana workspace.
final
grafanaVersion → Input<String?>?
Specifies the version of Grafana to support in the new workspace. Supported values are 9.4, 10.4 and 12.4. If not specified, defaults to the latest version.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
The ARN of the AWS KMS key for encrypting workspace data.
final
name → Input<String?>?
The Grafana workspace name.
final
networkAccessControl → Input<WorkspaceNetworkAccessControl?>?
Configuration for network access to your workspace.See Network Access Control below.
final
notificationDestinations → Input<List<String>?>?
The notification destinations. If a data source is specified here, Amazon Managed Grafana will create IAM roles and permissions needed to use these destinations. Must be set to SNS.
final
organizationalUnits → Input<List<String>?>?
The Amazon Organizations organizational units that the workspace is authorized to use data sources from.
final
organizationRoleName → Input<String?>?
The role name that the workspace uses to access resources through Amazon Organizations.
final
permissionType → Input<String?>?
The permission type of the workspace. If SERVICE_MANAGED is specified, the IAM roles and IAM policy attachments are generated automatically. If CUSTOMER_MANAGED is specified, the IAM roles and IAM policy attachments will not be created.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String?>?
The IAM role ARN that the workspace assumes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samlConfigurationStatus → Input<String?>?
final
stackSetName → Input<String?>?
The AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.
final
tags → Input<Map<String, String>?>?
Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
vpcConfiguration → Input<WorkspaceVpcConfiguration?>?
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. See VPC Configuration below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited