Class CfnWorkspace

Specifies a workspace .

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnWorkspace

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Grafana

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkspace : CfnResource, IInspectable

Syntax (vb)

Public Class CfnWorkspace
    Inherits CfnResource
    Implements IInspectable

Remarks

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.

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

CloudformationResource: AWS::Grafana::Workspace

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 cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", 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",
    PluginAdminEnabled = false,
    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

Constructors

CfnWorkspace(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnWorkspace(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnWorkspace(Construct, String, ICfnWorkspaceProps)

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.
AttrCreationTimestamp	The date that the workspace was created.
AttrEndpoint	The URL that users can use to access the Grafana console in the workspace.
AttrGrafanaVersion	Specifies the version of Grafana supported by this workspace.
AttrId	The unique ID of this workspace.
AttrModificationTimestamp	The most recent date that the workspace was modified.
AttrSamlConfigurationStatus	Specifies whether the workspace's SAML configuration is complete.
AttrSsoClientId	The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .
AttrStatus	The current status of the workspace.
AuthenticationProviders	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 .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.
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 `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.
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 `Admin` and `Editor` roles in the workspace.
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnWorkspace(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnWorkspace(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnWorkspace(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnWorkspace(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnWorkspace(Construct, String, ICfnWorkspaceProps)

public CfnWorkspace(Construct scope, string id, ICfnWorkspaceProps props)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnWorkspaceProps: Resource properties.

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 virtual string AccountAccessType { get; set; }

Property Value

System.String

AttrCreationTimestamp

The date that the workspace was created.

public virtual string AttrCreationTimestamp { get; }

Property Value

System.String

Remarks

Type: Timestamp

CloudformationAttribute: CreationTimestamp

AttrEndpoint

The URL that users can use to access the Grafana console in the workspace.

public virtual string AttrEndpoint { get; }

Property Value

System.String

Remarks

Type: String

CloudformationAttribute: Endpoint

AttrGrafanaVersion

Specifies the version of Grafana supported by this workspace.

public virtual string AttrGrafanaVersion { get; }

Property Value

System.String

Remarks

Type: String

CloudformationAttribute: GrafanaVersion

AttrId

The unique ID of this workspace.

public virtual string AttrId { get; }

Property Value

System.String

Remarks

Type: String

CloudformationAttribute: Id

AttrModificationTimestamp

The most recent date that the workspace was modified.

public virtual string AttrModificationTimestamp { get; }

Property Value

System.String

Remarks

Type: Timestamp

CloudformationAttribute: ModificationTimestamp

AttrSamlConfigurationStatus

Specifies whether the workspace's SAML configuration is complete.

public virtual string AttrSamlConfigurationStatus { get; }

Property Value

System.String

Remarks

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

CloudformationAttribute: SamlConfigurationStatus

AttrSsoClientId

The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .

public virtual string AttrSsoClientId { get; }

Property Value

System.String

Remarks

Type: String

CloudformationAttribute: SsoClientId

AttrStatus

The current status of the workspace.

public virtual string AttrStatus { get; }

Property Value

System.String

Remarks

Type: String

CloudformationAttribute: Status

AuthenticationProviders

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 .

public virtual string[] AuthenticationProviders { get; set; }

Property Value

System.String[]

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

ClientToken

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

public virtual string ClientToken { get; set; }

Property Value

System.String

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 virtual string[] DataSources { get; set; }

Property Value

System.String[]

Description

The user-defined description of the workspace.

public virtual string Description { get; set; }

Property Value

System.String

GrafanaVersion

Specifies the version of Grafana to support in the workspace.

public virtual string GrafanaVersion { get; set; }

Property Value

System.String

Name

The name of the workspace.

public virtual string Name { get; set; }

Property Value

System.String

NetworkAccessControl

The configuration settings for network access to your workspace.

public virtual object NetworkAccessControl { get; set; }

Property Value

System.Object

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 virtual string[] NotificationDestinations { get; set; }

Property Value

System.String[]

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 virtual string[] OrganizationalUnits { get; set; }

Property Value

System.String[]

OrganizationRoleName

The name of the IAM role that is used to access resources through Organizations.

public virtual string OrganizationRoleName { get; set; }

Property Value

System.String

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 virtual string PermissionType { get; set; }

Property Value

System.String

PluginAdminEnabled

Whether plugin administration is enabled in the workspace.

public virtual object PluginAdminEnabled { get; set; }

Property Value

System.Object

RoleArn

The IAM role that grants permissions to the AWS resources that the workspace will view data from.

public virtual string RoleArn { get; set; }

Property Value

System.String

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 virtual object SamlConfiguration { get; set; }

Property Value

System.Object

StackSetName

The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

public virtual string StackSetName { get; set; }

Property Value

System.String

VpcConfiguration

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

public virtual object VpcConfiguration { get; set; }

Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable