WorkspaceState class
Input properties used for looking up and filtering Workspace resources.
Constructors
-
WorkspaceState({Input<
String?> ? accountAccessType, Input<String?> ? arn, Input<List< ? authenticationProviders, Input<String> ?>String?> ? configuration, Input<List< ? dataSources, Input<String> ?>String?> ? description, Input<String?> ? endpoint, Input<String?> ? grafanaVersion, Input<String?> ? kmsKeyId, Input<String?> ? name, Input<WorkspaceNetworkAccessControl?> ? networkAccessControl, Input<List< ? notificationDestinations, Input<String> ?>String?> ? organizationRoleName, Input<List< ? organizationalUnits, Input<String> ?>String?> ? permissionType, Input<String?> ? region, Input<String?> ? roleArn, Input<String?> ? samlConfigurationStatus, Input<String?> ? stackSetName, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>WorkspaceVpcConfiguration?> ? vpcConfiguration}) -
Creates a new WorkspaceState.
accountAccessTypeThe type of account access for the workspace. Valid values areCURRENT_ACCOUNTandORGANIZATION. IfORGANIZATIONis specified, thenorganizationalUnitsmust also be present.arnARN of the Grafana workspace.authenticationProvidersThe authentication providers for the workspace. Valid values areAWS_SSO,SAML, or both.configurationThe configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.dataSourcesThe data sources for the workspace. Valid values areAMAZON_OPENSEARCH_SERVICE,ATHENA,CLOUDWATCH,PROMETHEUS,REDSHIFT,SITEWISE,TIMESTREAM,TWINMAKER,XRAYdescriptionThe workspace description.endpointThe endpoint of the Grafana workspace.grafanaVersionSpecifies the version of Grafana to support in the new workspace. Supported values are9.4,10.4and12.4. If not specified, defaults to the latest version.kmsKeyIdThe ARN of the AWS KMS key for encrypting workspace data.nameThe Grafana workspace name.networkAccessControlConfiguration for network access to your workspace.See Network Access Control below.notificationDestinationsThe 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 toSNS.organizationRoleNameThe role name that the workspace uses to access resources through Amazon Organizations.organizationalUnitsThe Amazon Organizations organizational units that the workspace is authorized to use data sources from.permissionTypeThe permission type of the workspace. IfSERVICE_MANAGEDis specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGEDis specified, the IAM roles and IAM policy attachments will not be created.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnThe IAM role ARN that the workspace assumes.samlConfigurationStatusOptional.stackSetNameThe AWS CloudFormation stack set name that provisions IAM roles to be used by the workspace.tagsKey-value mapping of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-leveltagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.vpcConfigurationThe 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_ACCOUNTandORGANIZATION. IfORGANIZATIONis specified, thenorganizationalUnitsmust 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,XRAYfinal -
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.4and12.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_MANAGEDis specified, the IAM roles and IAM policy attachments are generated automatically. IfCUSTOMER_MANAGEDis 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
-
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-levelfinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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