Interface ICfnWorkspaceProps
Properties for defining a CfnWorkspace
.
Namespace: Amazon.CDK.AWS.Grafana
Assembly: Amazon.CDK.AWS.Grafana.dll
Syntax (csharp)
public interface ICfnWorkspaceProps
Syntax (vb)
Public Interface ICfnWorkspaceProps
Remarks
Link: 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.AWS.Grafana;
var cfnWorkspaceProps = new CfnWorkspaceProps {
AccountAccessType = "accountAccessType",
AuthenticationProviders = new [] { "authenticationProviders" },
PermissionType = "permissionType",
// the properties below are optional
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",
RoleArn = "roleArn",
SamlConfiguration = new SamlConfigurationProperty {
IdpMetadata = new IdpMetadataProperty {
Url = "url",
Xml = "xml"
},
// the properties below are optional
AllowedOrganizations = new [] { "allowedOrganizations" },
AssertionAttributes = new AssertionAttributesProperty {
Email = "email",
Groups = "groups",
Login = "login",
Name = "name",
Org = "org",
Role = "role"
},
LoginValidityDuration = 123,
RoleValues = new RoleValuesProperty {
Admin = new [] { "admin" },
Editor = new [] { "editor" }
}
},
StackSetName = "stackSetName",
VpcConfiguration = new VpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
Synopsis
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, AWS IAM Identity Center (successor to AWS Single Sign-On) , 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 new 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. |
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. |
OrganizationRoleName | The name of the IAM role that is used to access resources through Organizations . |
PermissionType | If this is |
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. |
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.
string AccountAccessType { get; }
Property Value
System.String
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, AWS IAM Identity Center (successor to AWS Single Sign-On) , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .
string[] AuthenticationProviders { get; }
Property Value
System.String[]
Remarks
ClientToken
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
virtual string ClientToken { get; }
Property Value
System.String
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.
virtual string[] DataSources { get; }
Property Value
System.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.
virtual string Description { get; }
Property Value
System.String
Remarks
GrafanaVersion
Specifies the version of Grafana to support in the new workspace.
virtual string GrafanaVersion { get; }
Property Value
System.String
Remarks
Supported values are 8.4
and 9.4
.
Name
The name of the workspace.
virtual string Name { get; }
Property Value
System.String
Remarks
NetworkAccessControl
The configuration settings for network access to your workspace.
virtual object NetworkAccessControl { get; }
Property Value
System.Object
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.
virtual string[] NotificationDestinations { get; }
Property Value
System.String[]
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.
virtual string[] OrganizationalUnits { get; }
Property Value
System.String[]
Remarks
OrganizationRoleName
The name of the IAM role that is used to access resources through Organizations .
virtual string OrganizationRoleName { get; }
Property Value
System.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.
string PermissionType { get; }
Property Value
System.String
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
RoleArn
The IAM role that grants permissions to the AWS resources that the workspace will view data from.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
This role must already exist.
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.
virtual object SamlConfiguration { get; }
Property Value
System.Object
Remarks
StackSetName
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
virtual string StackSetName { get; }
Property Value
System.String
Remarks
VpcConfiguration
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
virtual object VpcConfiguration { get; }
Property Value
System.Object
Remarks
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).