Module library

Managed Grafana

Terraform module to create AWS Managed Service for Grafana (AMG) resources

Inputs

40 / 56
account_access_typeoptionalstring

The type of account access for the workspace. Valid values are `CURRENT_ACCOUNT` and `ORGANIZATION`

DefaultCURRENT_ACCOUNT
associate_licenseoptionalbool

Determines whether a license will be associated with the workspace

Defaulttrue
authentication_providersoptionallist(string)

The authentication providers for the workspace. Valid values are `AWS_SSO`, `SAML`, or both

Default[…]
configurationoptionalstring

The configuration string for the workspace

Defaultnull
createoptionalbool

Determines whether a resources will be created

Defaulttrue
create_iam_roleoptionalbool

Determines whether a an IAM role is created or to use an existing IAM role

Defaulttrue
create_saml_configurationoptionalbool

Determines whether the SAML configuration will be created

Defaulttrue
create_security_groupoptionalbool

Determines if a security group is created

Defaulttrue
create_workspaceoptionalbool

Determines whether a workspace will be created or to use an existing workspace

Defaulttrue
data_sourcesoptionallist(string)

The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `XRAY`

Default[]
descriptionoptionalstring

The workspace description

Defaultnull
enable_alertsoptionalbool

Determines whether IAM permissions for alerting are enabled for the workspace IAM role

Defaultfalse
grafana_tokenoptionalstring

A token from Grafana Labs that ties your AWS account with a Grafana Labs account

Defaultnull
grafana_versionoptionalstring

Specifies the version of Grafana to support in the new workspace. If not specified, the default version for the `aws_grafana_workspace` resource will be used. See `aws_grafana_workspace` documentation for available options.

Defaultnull
iam_role_arnoptionalstring

Existing IAM role ARN for the workspace. Required if `create_iam_role` is set to `false`

Defaultnull
iam_role_descriptionoptionalstring

The description of the workspace IAM role

Defaultnull
iam_role_force_detach_policiesoptionalbool

Determines whether the workspace IAM role policies will be forced to detach

Defaulttrue
iam_role_max_session_durationoptionalnumber

Maximum session duration (in seconds) that you want to set for the IAM role

Defaultnull
iam_role_nameoptionalstring

Name to use on workspace IAM role created

Defaultnull
iam_role_pathoptionalstring

Workspace IAM role path

Defaultnull
iam_role_permissions_boundaryoptionalstring

ARN of the policy that is used to set the permissions boundary for the IAM role

Defaultnull
iam_role_policy_arnsoptionallist(string)

List of ARNs of IAM policies to attach to the workspace IAM role

Default[]
iam_role_tagsoptionalmap(string)

A map of additional tags to add to the IAM role created

Default{}
license_typeoptionalstring

The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`

DefaultENTERPRISE
nameoptionalstring

The Grafana workspace name

Defaultnull
network_access_controloptionalany

Configuration for network access to your workspace

Default{}
notification_destinationsoptionallist(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`

Default[]
organization_role_nameoptionalstring

The role name that the workspace uses to access resources through Amazon Organizations

Defaultnull
organizational_unitsoptionallist(string)

The Amazon Organizations organizational units that the workspace is authorized to use data sources from

Default[]
permission_typeoptionalstring

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

DefaultSERVICE_MANAGED
role_associationsoptionalany

Map of maps to assocaite user/group IDs to a role. Map key can be used as the `role`

Default{}
saml_admin_role_valuesoptionallist(string)

SAML authentication admin role values

Default[]
saml_allowed_organizationsoptionallist(string)

SAML authentication allowed organizations

Default[]
saml_editor_role_valuesoptionallist(string)

SAML authentication editor role values

Default[]
saml_email_assertionoptionalstring

SAML authentication email assertion

Defaultnull
saml_groups_assertionoptionalstring

SAML authentication groups assertion

Defaultnull
saml_idp_metadata_urloptionalstring

SAML authentication IDP Metadata URL. Note that either `saml_idp_metadata_url` or `saml_idp_metadata_xml`

Defaultnull
saml_idp_metadata_xmloptionalstring

SAML authentication IDP Metadata XML. Note that either `saml_idp_metadata_url` or `saml_idp_metadata_xml`

Defaultnull
saml_login_assertionoptionalstring

SAML authentication email assertion

Defaultnull
saml_login_validity_durationoptionalnumber

SAML authentication login validity duration

Defaultnull

All 56 are optional — the module deploys with none of them set. Showing 40, so the site stays a static download — the remaining 16 are in the source.

Outputs

18
license_expiration

If `license_type` is set to `ENTERPRISE`, this is the expiration date of the enterprise license

license_free_trial_expiration

If `license_type` is set to `ENTERPRISE_FREE_TRIAL`, this is the expiration date of the free trial

saml_configuration_status

Status of the SAML configuration

security_group_arn

Amazon Resource Name (ARN) of the security group

security_group_id

ID of the security group

workspace_api_keys

The workspace API keys created including their attributes

workspace_arn

The Amazon Resource Name (ARN) of the Grafana workspace

workspace_endpoint

The endpoint of the Grafana workspace

workspace_grafana_version

The version of Grafana running on the workspace

workspace_iam_role_arn

IAM role ARN of the Grafana workspace

workspace_iam_role_name

IAM role name of the Grafana workspace

workspace_iam_role_policy_arn

IAM Policy ARN of the Grafana workspace IAM role

workspace_iam_role_policy_id

Stable and unique string identifying the IAM Policy

workspace_iam_role_policy_name

IAM Policy name of the Grafana workspace IAM role

workspace_iam_role_unique_id

Stable and unique string identifying the IAM role

workspace_id

The ID of the Grafana workspace

workspace_service_account_tokens

The workspace service account tokens created including their attributes

workspace_service_accounts

The workspace service accounts created including their attributes

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.