Class CfnWorkspaceMixinProps
Properties for CfnWorkspacePropsMixin.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Grafana
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnWorkspaceMixinProps : ICfnWorkspaceMixinPropsSyntax (vb)
Public Class CfnWorkspaceMixinProps Implements ICfnWorkspaceMixinPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Grafana;
var cfnWorkspaceMixinProps = new CfnWorkspaceMixinProps {
AccountAccessType = "accountAccessType",
AuthenticationProviders = new [] { "authenticationProviders" },
ClientToken = "clientToken",
DataSources = new [] { "dataSources" },
Description = "description",
GrafanaVersion = "grafanaVersion",
Name = "name",
NetworkAccessControl = new NetworkAccessControlProperty {
PrefixListIds = new [] { "prefixListIds" },
VpceIds = new [] { "vpceIds" }
},
NotificationDestinations = new [] { "notificationDestinations" },
OrganizationalUnits = new [] { "organizationalUnits" },
OrganizationRoleName = "organizationRoleName",
PermissionType = "permissionType",
PluginAdminEnabled = false,
RoleArn = "roleArn",
SamlConfiguration = new SamlConfigurationProperty {
AllowedOrganizations = new [] { "allowedOrganizations" },
AssertionAttributes = new AssertionAttributesProperty {
Email = "email",
Groups = "groups",
Login = "login",
Name = "name",
Org = "org",
Role = "role"
},
IdpMetadata = new IdpMetadataProperty {
Url = "url",
Xml = "xml"
},
LoginValidityDuration = 123,
RoleValues = new RoleValuesProperty {
Admin = new [] { "admin" },
Editor = new [] { "editor" }
}
},
StackSetName = "stackSetName",
VpcConfiguration = new VpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};Synopsis
Constructors
| CfnWorkspaceMixinProps() | Properties for CfnWorkspacePropsMixin. |
Properties
| AccountAccessType | 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. |
| AuthenticationProviders | Specifies whether this workspace uses SAML 2.0, SSOlong , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana . |
| ClientToken | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
| DataSources | 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. |
| Description | The user-defined description of the workspace. |
| GrafanaVersion | Specifies the version of Grafana to support in the workspace. |
| Name | The name of the workspace. |
| NetworkAccessControl | The configuration settings for network access to your workspace. |
| NotificationDestinations | 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. |
| OrganizationRoleName | The name of the IAM role that is used to access resources through Organizations. |
| OrganizationalUnits | 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. |
| PermissionType | If this is |
| PluginAdminEnabled | Whether plugin administration is enabled in the workspace. |
| RoleArn | The IAM role that grants permissions to the AWS resources that the workspace will view data from. |
| SamlConfiguration | 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 |
| StackSetName | The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. |
| VpcConfiguration | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
Constructors
CfnWorkspaceMixinProps()
Properties for CfnWorkspacePropsMixin.
public CfnWorkspaceMixinProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Grafana;
var cfnWorkspaceMixinProps = new CfnWorkspaceMixinProps {
AccountAccessType = "accountAccessType",
AuthenticationProviders = new [] { "authenticationProviders" },
ClientToken = "clientToken",
DataSources = new [] { "dataSources" },
Description = "description",
GrafanaVersion = "grafanaVersion",
Name = "name",
NetworkAccessControl = new NetworkAccessControlProperty {
PrefixListIds = new [] { "prefixListIds" },
VpceIds = new [] { "vpceIds" }
},
NotificationDestinations = new [] { "notificationDestinations" },
OrganizationalUnits = new [] { "organizationalUnits" },
OrganizationRoleName = "organizationRoleName",
PermissionType = "permissionType",
PluginAdminEnabled = false,
RoleArn = "roleArn",
SamlConfiguration = new SamlConfigurationProperty {
AllowedOrganizations = new [] { "allowedOrganizations" },
AssertionAttributes = new AssertionAttributesProperty {
Email = "email",
Groups = "groups",
Login = "login",
Name = "name",
Org = "org",
Role = "role"
},
IdpMetadata = new IdpMetadataProperty {
Url = "url",
Xml = "xml"
},
LoginValidityDuration = 123,
RoleValues = new RoleValuesProperty {
Admin = new [] { "admin" },
Editor = new [] { "editor" }
}
},
StackSetName = "stackSetName",
VpcConfiguration = new VpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};Properties
AccountAccessType
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.
public string? AccountAccessType { get; set; }Property Value
Remarks
If this is ORGANIZATION , the OrganizationalUnits parameter specifies which organizational units the workspace can access.
AuthenticationProviders
Specifies whether this workspace uses SAML 2.0, SSOlong , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .
public string[]? AuthenticationProviders { get; set; }Property Value
string[]
Remarks
Allowed Values : AWS_SSO | SAML
ClientToken
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
public string? ClientToken { get; set; }Property Value
Remarks
DataSources
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.
public string[]? DataSources { get; set; }Property Value
string[]
Remarks
This list is only used when the workspace was created through the AWS console, and the permissionType is SERVICE_MANAGED .
Description
The user-defined description of the workspace.
public string? Description { get; set; }Property Value
Remarks
GrafanaVersion
Specifies the version of Grafana to support in the workspace.
public string? GrafanaVersion { get; set; }Property Value
Remarks
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 operation.
Name
The name of the workspace.
public string? Name { get; set; }Property Value
Remarks
NetworkAccessControl
The configuration settings for network access to your workspace.
public object? NetworkAccessControl { get; set; }Property Value
Remarks
NotificationDestinations
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.
public string[]? NotificationDestinations { get; set; }Property Value
string[]
Remarks
OrganizationRoleName
The name of the IAM role that is used to access resources through Organizations.
public string? OrganizationRoleName { get; set; }Property Value
Remarks
OrganizationalUnits
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.
public string[]? OrganizationalUnits { get; set; }Property Value
string[]
Remarks
PermissionType
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.
public string? PermissionType { get; set; }Property Value
Remarks
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 . 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
PluginAdminEnabled
Whether plugin administration is enabled in the workspace.
public object? PluginAdminEnabled { get; set; }Property Value
Remarks
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.
Type union: either bool or IResolvable
RoleArn
The IAM role that grants permissions to the AWS resources that the workspace will view data from.
public object? RoleArn { get; set; }Property Value
Remarks
This role must already exist.
Type union: either string or IRoleRef
SamlConfiguration
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.
public object? SamlConfiguration { get; set; }Property Value
Remarks
StackSetName
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
public string? StackSetName { get; set; }Property Value
Remarks
VpcConfiguration
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
public object? VpcConfiguration { get; set; }Property Value
Remarks
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
Type union: either IResolvable or CfnWorkspacePropsMixin.IVpcConfigurationProperty