awsgrafana

README

AWS::Grafana Construct Library

This module is part of the AWS Cloud Development Kit project.

import grafana "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Grafana construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Grafana resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Grafana.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

• func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string
• func CfnWorkspace_IsCfnElement(x interface{}) *bool
• func CfnWorkspace_IsCfnResource(x interface{}) *bool
• func CfnWorkspace_IsConstruct(x interface{}) *bool
• func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, ...)
• type CfnWorkspace
  • func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace
• type CfnWorkspaceProps
• type CfnWorkspace_AssertionAttributesProperty
• type CfnWorkspace_IdpMetadataProperty
• type CfnWorkspace_NetworkAccessControlProperty
• type CfnWorkspace_RoleValuesProperty
• type CfnWorkspace_SamlConfigurationProperty
• type CfnWorkspace_VpcConfigurationProperty

Functions

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME

func CfnWorkspace_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkspace_IsCfnElement

func CfnWorkspace_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnWorkspace_IsCfnResource

func CfnWorkspace_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnWorkspace_IsConstruct

func CfnWorkspace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnWorkspace_Override

func NewCfnWorkspace_Override(c CfnWorkspace, scope constructs.Construct, id *string, props *CfnWorkspaceProps)

Types

type CfnWorkspace

type CfnWorkspace interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization.
	AccountAccessType() *string
	SetAccountAccessType(val *string)
	// The date that the workspace was created.
	//
	// Type: Timestamp.
	AttrCreationTimestamp() *string
	// The URL that users can use to access the Grafana console in the workspace.
	//
	// Type: String.
	AttrEndpoint() *string
	// Specifies the version of Grafana supported by this workspace.
	//
	// Type: String.
	AttrGrafanaVersion() *string
	// The unique ID of this workspace.
	//
	// Type: String.
	AttrId() *string
	// The most recent date that the workspace was modified.
	//
	// Type: Timestamp.
	AttrModificationTimestamp() *string
	// Specifies whether the workspace's SAML configuration is complete.
	//
	// Valid values: `CONFIGURED | NOT_CONFIGURED`
	//
	// Type: String.
	AttrSamlConfigurationStatus() *string
	// The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .
	//
	// Type: String.
	AttrSsoClientId() *string
	// The current status of the workspace.
	//
	// Valid values: `ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED`
	//
	// Type: String.
	AttrStatus() *string
	// Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) .
	AuthenticationProviders() *[]*string
	SetAuthenticationProviders(val *[]*string)
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
	ClientToken() *string
	SetClientToken(val *string)
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
	DataSources() *[]*string
	SetDataSources(val *[]*string)
	// The user-defined description of the workspace.
	Description() *string
	SetDescription(val *string)
	// Specifies the version of Grafana to support in the workspace.
	GrafanaVersion() *string
	SetGrafanaVersion(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The name of the workspace.
	Name() *string
	SetName(val *string)
	// The configuration settings for network access to your workspace.
	NetworkAccessControl() interface{}
	SetNetworkAccessControl(val interface{})
	// The tree node.
	Node() constructs.Node
	// The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.
	NotificationDestinations() *[]*string
	SetNotificationDestinations(val *[]*string)
	// Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
	OrganizationalUnits() *[]*string
	SetOrganizationalUnits(val *[]*string)
	// The name of the IAM role that is used to access resources through Organizations .
	OrganizationRoleName() *string
	SetOrganizationRoleName(val *string)
	// If this is `SERVICE_MANAGED` , and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels.
	PermissionType() *string
	SetPermissionType(val *string)
	// Whether plugin administration is enabled in the workspace.
	PluginAdminEnabled() interface{}
	SetPluginAdminEnabled(val interface{})
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The IAM role that grants permissions to the AWS resources that the workspace will view data from.
	RoleArn() *string
	SetRoleArn(val *string)
	// If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace.
	SamlConfiguration() interface{}
	SetSamlConfiguration(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
	StackSetName() *string
	SetStackSetName(val *string)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
	VpcConfiguration() interface{}
	SetVpcConfiguration(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

Specifies a *workspace* .

In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWorkspace := awscdk.Aws_grafana.NewCfnWorkspace(this, jsii.String("MyCfnWorkspace"), &CfnWorkspaceProps{
	AccountAccessType: jsii.String("accountAccessType"),
	AuthenticationProviders: []*string{
		jsii.String("authenticationProviders"),
	},
	PermissionType: jsii.String("permissionType"),

	// the properties below are optional
	ClientToken: jsii.String("clientToken"),
	DataSources: []*string{
		jsii.String("dataSources"),
	},
	Description: jsii.String("description"),
	GrafanaVersion: jsii.String("grafanaVersion"),
	Name: jsii.String("name"),
	NetworkAccessControl: &NetworkAccessControlProperty{
		PrefixListIds: []*string{
			jsii.String("prefixListIds"),
		},
		VpceIds: []*string{
			jsii.String("vpceIds"),
		},
	},
	NotificationDestinations: []*string{
		jsii.String("notificationDestinations"),
	},
	OrganizationalUnits: []*string{
		jsii.String("organizationalUnits"),
	},
	OrganizationRoleName: jsii.String("organizationRoleName"),
	PluginAdminEnabled: jsii.Boolean(false),
	RoleArn: jsii.String("roleArn"),
	SamlConfiguration: &SamlConfigurationProperty{
		IdpMetadata: &IdpMetadataProperty{
			Url: jsii.String("url"),
			Xml: jsii.String("xml"),
		},

		// the properties below are optional
		AllowedOrganizations: []*string{
			jsii.String("allowedOrganizations"),
		},
		AssertionAttributes: &AssertionAttributesProperty{
			Email: jsii.String("email"),
			Groups: jsii.String("groups"),
			Login: jsii.String("login"),
			Name: jsii.String("name"),
			Org: jsii.String("org"),
			Role: jsii.String("role"),
		},
		LoginValidityDuration: jsii.Number(123),
		RoleValues: &RoleValuesProperty{
			Admin: []*string{
				jsii.String("admin"),
			},
			Editor: []*string{
				jsii.String("editor"),
			},
		},
	},
	StackSetName: jsii.String("stackSetName"),
	VpcConfiguration: &VpcConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html

func NewCfnWorkspace

func NewCfnWorkspace(scope constructs.Construct, id *string, props *CfnWorkspaceProps) CfnWorkspace

type CfnWorkspaceProps

type CfnWorkspaceProps struct {
	// Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization.
	//
	// If this is `ORGANIZATION` , the `OrganizationalUnits` parameter specifies which organizational units the workspace can access.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-accountaccesstype
	//
	AccountAccessType *string `field:"required" json:"accountAccessType" yaml:"accountAccessType"`
	// Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-authenticationproviders
	//
	AuthenticationProviders *[]*string `field:"required" json:"authenticationProviders" yaml:"authenticationProviders"`
	// If this is `SERVICE_MANAGED` , and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels.
	//
	// If this is `CUSTOMER_MANAGED` , you must manage those roles and permissions yourself.
	//
	// If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to `CUSTOMER_MANAGED` .
	//
	// For more information about converting between customer and service managed, see [Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html) . For more information about the roles and permissions that must be managed for customer managed workspaces, see [Amazon Managed Grafana permissions and policies for AWS data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-permissiontype
	//
	PermissionType *string `field:"required" json:"permissionType" yaml:"permissionType"`
	// A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-clienttoken
	//
	ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"`
	// Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
	//
	// This list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-datasources
	//
	DataSources *[]*string `field:"optional" json:"dataSources" yaml:"dataSources"`
	// The user-defined description of the workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-description
	//
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Specifies the version of Grafana to support in the workspace.
	//
	// Defaults to the latest version on create (for example, 9.4), or the current version of the workspace on update.
	//
	// Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).
	//
	// To know what versions are available to upgrade to for a specific workspace, see the [ListVersions](https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html) operation.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-grafanaversion
	//
	GrafanaVersion *string `field:"optional" json:"grafanaVersion" yaml:"grafanaVersion"`
	// The name of the workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-name
	//
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The configuration settings for network access to your workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-networkaccesscontrol
	//
	NetworkAccessControl interface{} `field:"optional" json:"networkAccessControl" yaml:"networkAccessControl"`
	// The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-notificationdestinations
	//
	NotificationDestinations *[]*string `field:"optional" json:"notificationDestinations" yaml:"notificationDestinations"`
	// Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-organizationalunits
	//
	OrganizationalUnits *[]*string `field:"optional" json:"organizationalUnits" yaml:"organizationalUnits"`
	// The name of the IAM role that is used to access resources through Organizations .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-organizationrolename
	//
	OrganizationRoleName *string `field:"optional" json:"organizationRoleName" yaml:"organizationRoleName"`
	// Whether plugin administration is enabled in the workspace.
	//
	// Setting to `true` allows workspace admins to install, uninstall, and update plugins from within the Grafana workspace.
	//
	// > This option is only valid for workspaces that support Grafana version 9 or newer.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-pluginadminenabled
	//
	PluginAdminEnabled interface{} `field:"optional" json:"pluginAdminEnabled" yaml:"pluginAdminEnabled"`
	// The IAM role that grants permissions to the AWS resources that the workspace will view data from.
	//
	// This role must already exist.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-rolearn
	//
	RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
	// If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-samlconfiguration
	//
	SamlConfiguration interface{} `field:"optional" json:"samlConfiguration" yaml:"samlConfiguration"`
	// The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-stacksetname
	//
	StackSetName *string `field:"optional" json:"stackSetName" yaml:"stackSetName"`
	// The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
	//
	// > Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html#cfn-grafana-workspace-vpcconfiguration
	//
	VpcConfiguration interface{} `field:"optional" json:"vpcConfiguration" yaml:"vpcConfiguration"`
}

Properties for defining a `CfnWorkspace`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWorkspaceProps := &CfnWorkspaceProps{
	AccountAccessType: jsii.String("accountAccessType"),
	AuthenticationProviders: []*string{
		jsii.String("authenticationProviders"),
	},
	PermissionType: jsii.String("permissionType"),

	// the properties below are optional
	ClientToken: jsii.String("clientToken"),
	DataSources: []*string{
		jsii.String("dataSources"),
	},
	Description: jsii.String("description"),
	GrafanaVersion: jsii.String("grafanaVersion"),
	Name: jsii.String("name"),
	NetworkAccessControl: &NetworkAccessControlProperty{
		PrefixListIds: []*string{
			jsii.String("prefixListIds"),
		},
		VpceIds: []*string{
			jsii.String("vpceIds"),
		},
	},
	NotificationDestinations: []*string{
		jsii.String("notificationDestinations"),
	},
	OrganizationalUnits: []*string{
		jsii.String("organizationalUnits"),
	},
	OrganizationRoleName: jsii.String("organizationRoleName"),
	PluginAdminEnabled: jsii.Boolean(false),
	RoleArn: jsii.String("roleArn"),
	SamlConfiguration: &SamlConfigurationProperty{
		IdpMetadata: &IdpMetadataProperty{
			Url: jsii.String("url"),
			Xml: jsii.String("xml"),
		},

		// the properties below are optional
		AllowedOrganizations: []*string{
			jsii.String("allowedOrganizations"),
		},
		AssertionAttributes: &AssertionAttributesProperty{
			Email: jsii.String("email"),
			Groups: jsii.String("groups"),
			Login: jsii.String("login"),
			Name: jsii.String("name"),
			Org: jsii.String("org"),
			Role: jsii.String("role"),
		},
		LoginValidityDuration: jsii.Number(123),
		RoleValues: &RoleValuesProperty{
			Admin: []*string{
				jsii.String("admin"),
			},
			Editor: []*string{
				jsii.String("editor"),
			},
		},
	},
	StackSetName: jsii.String("stackSetName"),
	VpcConfiguration: &VpcConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html

type CfnWorkspace_AssertionAttributesProperty

type CfnWorkspace_AssertionAttributesProperty struct {
	// The name of the attribute within the SAML assertion to use as the email names for SAML users.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-email
	//
	Email *string `field:"optional" json:"email" yaml:"email"`
	// The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-groups
	//
	Groups *string `field:"optional" json:"groups" yaml:"groups"`
	// The name of the attribute within the SAML assertion to use as the login names for SAML users.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-login
	//
	Login *string `field:"optional" json:"login" yaml:"login"`
	// The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-name
	//
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-org
	//
	Org *string `field:"optional" json:"org" yaml:"org"`
	// The name of the attribute within the SAML assertion to use as the user roles.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-role
	//
	Role *string `field:"optional" json:"role" yaml:"role"`
}

A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

assertionAttributesProperty := &AssertionAttributesProperty{
	Email: jsii.String("email"),
	Groups: jsii.String("groups"),
	Login: jsii.String("login"),
	Name: jsii.String("name"),
	Org: jsii.String("org"),
	Role: jsii.String("role"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html

type CfnWorkspace_IdpMetadataProperty

type CfnWorkspace_IdpMetadataProperty struct {
	// The URL of the location containing the IdP metadata.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-url
	//
	Url *string `field:"optional" json:"url" yaml:"url"`
	// The full IdP metadata, in XML format.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html#cfn-grafana-workspace-idpmetadata-xml
	//
	Xml *string `field:"optional" json:"xml" yaml:"xml"`
}

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

You can specify the metadata either by providing a URL to its location in the `url` parameter, or by specifying the full metadata in XML format in the `xml` parameter. Specifying both will cause an error.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

idpMetadataProperty := &IdpMetadataProperty{
	Url: jsii.String("url"),
	Xml: jsii.String("xml"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html

type CfnWorkspace_NetworkAccessControlProperty

type CfnWorkspace_NetworkAccessControlProperty struct {
	// An array 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 (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console.
	//
	// Prefix list IDs have the format `pl- *1a2b3c4d*` .
	//
	// For more information about prefix lists, see [Group CIDR blocks using managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) in the *Amazon Virtual Private Cloud User Guide* .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html#cfn-grafana-workspace-networkaccesscontrol-prefixlistids
	//
	PrefixListIds *[]*string `field:"optional" json:"prefixListIds" yaml:"prefixListIds"`
	// An array of Amazon VPC endpoint IDs for the workspace.
	//
	// You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a `NetworkAccessConfiguration` is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
	//
	// VPC endpoint IDs have the format `vpce- *1a2b3c4d*` .
	//
	// For more information about creating an interface VPC endpoint, see [Interface VPC endpoints](https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) in the *Amazon Managed Grafana User Guide* .
	//
	// > The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the `com.amazonaws.[region].grafana-workspace` service endpoint). Other VPC endpoints are ignored.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html#cfn-grafana-workspace-networkaccesscontrol-vpceids
	//
	VpceIds *[]*string `field:"optional" json:"vpceIds" yaml:"vpceIds"`
}

The configuration settings for in-bound network access to your workspace.

When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization are still required.

Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both.

If this is not configured, or is removed, then all IP addresses and VPC endpoints are allowed. Standard Grafana authentication and authorization are still required.

> While both `prefixListIds` and `vpceIds` are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type. > > If both are passed as empty arrays, no traffic is allowed to the workspace, because only *explicitly* allowed connections are accepted.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

networkAccessControlProperty := &NetworkAccessControlProperty{
	PrefixListIds: []*string{
		jsii.String("prefixListIds"),
	},
	VpceIds: []*string{
		jsii.String("vpceIds"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-networkaccesscontrol.html

type CfnWorkspace_RoleValuesProperty

type CfnWorkspace_RoleValuesProperty struct {
	// A list of groups from the SAML assertion attribute to grant the Grafana `Admin` role to.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html#cfn-grafana-workspace-rolevalues-admin
	//
	Admin *[]*string `field:"optional" json:"admin" yaml:"admin"`
	// A list of groups from the SAML assertion attribute to grant the Grafana `Editor` role to.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html#cfn-grafana-workspace-rolevalues-editor
	//
	Editor *[]*string `field:"optional" json:"editor" yaml:"editor"`
}

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana `Admin` and `Editor` roles in the workspace.

SAML authenticated users not part of `Admin` or `Editor` role groups have `Viewer` permission over the workspace.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

roleValuesProperty := &RoleValuesProperty{
	Admin: []*string{
		jsii.String("admin"),
	},
	Editor: []*string{
		jsii.String("editor"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html

type CfnWorkspace_SamlConfigurationProperty

type CfnWorkspace_SamlConfigurationProperty struct {
	// A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-idpmetadata
	//
	IdpMetadata interface{} `field:"required" json:"idpMetadata" yaml:"idpMetadata"`
	// Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
	//
	// If this is empty, all organizations in the assertion attribute have access.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-allowedorganizations
	//
	AllowedOrganizations *[]*string `field:"optional" json:"allowedOrganizations" yaml:"allowedOrganizations"`
	// A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-assertionattributes
	//
	AssertionAttributes interface{} `field:"optional" json:"assertionAttributes" yaml:"assertionAttributes"`
	// How long a sign-on session by a SAML user is valid, before the user has to sign on again.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-loginvalidityduration
	//
	LoginValidityDuration *float64 `field:"optional" json:"loginValidityDuration" yaml:"loginValidityDuration"`
	// A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html#cfn-grafana-workspace-samlconfiguration-rolevalues
	//
	RoleValues interface{} `field:"optional" json:"roleValues" yaml:"roleValues"`
}

A structure containing information about how this workspace works with SAML.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

samlConfigurationProperty := &SamlConfigurationProperty{
	IdpMetadata: &IdpMetadataProperty{
		Url: jsii.String("url"),
		Xml: jsii.String("xml"),
	},

	// the properties below are optional
	AllowedOrganizations: []*string{
		jsii.String("allowedOrganizations"),
	},
	AssertionAttributes: &AssertionAttributesProperty{
		Email: jsii.String("email"),
		Groups: jsii.String("groups"),
		Login: jsii.String("login"),
		Name: jsii.String("name"),
		Org: jsii.String("org"),
		Role: jsii.String("role"),
	},
	LoginValidityDuration: jsii.Number(123),
	RoleValues: &RoleValuesProperty{
		Admin: []*string{
			jsii.String("admin"),
		},
		Editor: []*string{
			jsii.String("editor"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html

type CfnWorkspace_VpcConfigurationProperty

type CfnWorkspace_VpcConfigurationProperty struct {
	// The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect.
	//
	// Duplicates not allowed.
	//
	// *Array Members* : Minimum number of 1 items. Maximum number of 5 items.
	//
	// *Length* : Minimum length of 0. Maximum length of 255.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html#cfn-grafana-workspace-vpcconfiguration-securitygroupids
	//
	SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
	// The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect.
	//
	// Duplicates not allowed.
	//
	// *Array Members* : Minimum number of 2 items. Maximum number of 6 items.
	//
	// *Length* : Minimum length of 0. Maximum length of 255.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html#cfn-grafana-workspace-vpcconfiguration-subnetids
	//
	SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"`
}

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

> Provided `securityGroupIds` and `subnetIds` must be part of the same VPC. > > Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcConfigurationProperty := &VpcConfigurationProperty{
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	SubnetIds: []*string{
		jsii.String("subnetIds"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html