@robhan-cdk-lib/aws_grafana 0.0.402 → 0.1.0

package/lib/workspace-base.d.ts

@@ -43,7 +43,9 @@ export interface NetworkAccessControl {
      * configuration (passed an empty array) then no IP addresses are allowed to access the
      * workspace.
      *
-     * Maximum of 5 prefix lists allowed.
+     * A maximum of 5 prefix lists is allowed (validated by CloudFormation at deploy time).
+     *
+     * @default - no prefix lists; combined with an empty `vpcEndpoints`, all traffic is denied
      */
     readonly prefixLists?: IPrefixList[];
     /**
@@ -52,7 +54,9 @@ export interface NetworkAccessControl {
      * 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.
      *
-     * Maximum of 5 VPC endpoints allowed.
+     * A maximum of 5 VPC endpoints is allowed (validated by CloudFormation at deploy time).
+     *
+     * @default - no VPC endpoints; combined with an empty `prefixLists`, all traffic is denied
      */
     readonly vpcEndpoints?: IVpcEndpoint[];
 }
@@ -83,7 +87,11 @@ export declare enum PermissionTypes {
      */
     CUSTOMER_MANAGED = "CUSTOMER_MANAGED",
     /**
-     * Service-managed permissions where AWS manages user access to Grafana.
+     * Service-managed permissions, where Amazon Managed Grafana creates and manages the IAM roles.
+     *
+     * Per the Amazon Managed Grafana API, this value is valid only for workspaces created through the
+     * console; workspaces created via the API, CLI, or CloudFormation (including this construct) must
+     * use `CUSTOMER_MANAGED`.
      */
     SERVICE_MANAGED = "SERVICE_MANAGED"
 }
@@ -97,40 +105,52 @@ export interface SamlAssertionAttributes {
     /**
      * The name of the attribute within the SAML assertion to use as the email names for SAML users.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no email attribute mapping
      */
     readonly email?: string;
     /**
      * The name of the attribute within the SAML assertion to use as the user full "friendly" names
      * for user groups.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no groups attribute mapping
      */
     readonly groups?: string;
     /**
      * The name of the attribute within the SAML assertion to use as the login names for SAML users.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no login attribute mapping
      */
     readonly login?: string;
     /**
      * The name of the attribute within the SAML assertion to use as the user full "friendly" names
      * for SAML users.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no name attribute mapping
      */
     readonly name?: string;
     /**
      * The name of the attribute within the SAML assertion to use as the user full "friendly" names
      * for the users' organizations.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no org attribute mapping
      */
     readonly org?: string;
     /**
      * The name of the attribute within the SAML assertion to use as the user roles.
      *
-     * Must be between 1 and 256 characters long.
+     * Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
+     *
+     * @default - no role attribute mapping
      */
     readonly role?: string;
 }
@@ -142,11 +162,16 @@ export interface SamlIdpMetadata {
     /**
      * The URL of the location containing the IdP metadata.
      *
-     * Must be a string with length between 1 and 2048 characters.
+     * Must be a string with length between 1 and 2048 characters (validated by CloudFormation at
+     * deploy time).
+     *
+     * @default - no metadata URL; supply `xml` instead
      */
     readonly url?: string;
     /**
      * The full IdP metadata, in XML format.
+     *
+     * @default - no inline metadata; supply `url` instead
      */
     readonly xml?: string;
 }
@@ -158,13 +183,17 @@ export interface SamlRoleValues {
     /**
      * A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
      *
-     * Maximum of 256 elements.
+     * A maximum of 256 elements is allowed (validated by CloudFormation at deploy time).
+     *
+     * @default - no groups are granted the Admin role
      */
     readonly admin?: string[];
     /**
      * A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
      *
-     * Maximum of 256 elements.
+     * A maximum of 256 elements is allowed (validated by CloudFormation at deploy time).
+     *
+     * @default - no groups are granted the Editor role
      */
     readonly editor?: string[];
 }
@@ -178,14 +207,18 @@ export interface SamlConfiguration {
      * 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.
      *
-     * Must have between 1 and 256 elements.
+     * Must have between 1 and 256 elements (validated by CloudFormation at deploy time).
+     *
+     * @default - all organizations in the assertion attribute have access
      */
     readonly allowedOrganizations?: string[];
     /**
      * 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.
+     *
+     * @default - no assertion attribute mapping
      */
-    readonly assertionAtrributes?: SamlAssertionAttributes;
+    readonly assertionAttributes?: SamlAssertionAttributes;
     /**
      * A structure containing the identity provider (IdP) metadata used to integrate the identity
      * provider with this workspace.
@@ -196,12 +229,16 @@ export interface SamlConfiguration {
     /**
      * How long a sign-on session by a SAML user is valid, before the user has to sign on again.
      *
-     * Must be a positive number.
+     * Must be a positive number (validated by CloudFormation at deploy time).
+     *
+     * @default - the service default session validity applies
      */
     readonly loginValidityDuration?: number;
     /**
      * A structure containing arrays that map group names in the SAML assertion to the Grafana Admin
      * and Editor roles in the workspace.
+     *
+     * @default - no role mapping
      */
     readonly roleValues?: SamlRoleValues;
 }
@@ -214,7 +251,8 @@ export interface VpcConfiguration {
      * The list of Amazon EC2 security groups 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.
+     * Array members: minimum of 1 item, maximum of 5 items (validated by CloudFormation at deploy
+     * time).
      *
      * Required for VPC configuration.
      */
@@ -223,7 +261,8 @@ export interface VpcConfiguration {
      * The list of Amazon EC2 subnets 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.
+     * Array members: minimum of 2 items, maximum of 6 items (validated by CloudFormation at deploy
+     * time).
      *
      * Required for VPC configuration.
      */
@@ -300,15 +339,21 @@ export interface IWorkspace extends IResource {
      * 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.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    readonly accountAccessType: AccountAccessType;
+    readonly accountAccessType?: 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.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    readonly authenticationProviders: AuthenticationProviders[];
+    readonly authenticationProviders?: AuthenticationProviders[];
     /**
      * A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
+     *
+     * @default - not available on imported workspaces
      */
     readonly clientToken?: string;
     /**
@@ -316,33 +361,48 @@ export interface IWorkspace extends IResource {
      * 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.
+     * permissionType is SERVICE_MANAGED. The Amazon Managed Grafana API marks this parameter as for
+     * internal use only and recommends against setting it.
+     *
+     * @default - no data sources
      */
     readonly dataSources?: string[];
     /**
      * The user-defined description of the workspace.
+     *
+     * @default - no description
      */
     readonly description?: string;
     /**
      * The name of the workspace.
+     *
+     * @default - a name is generated by CloudFormation
      */
     readonly name?: string;
     /**
      * The configuration settings for network access to your workspace.
+     *
+     * @default - no network access control, the workspace is open to all traffic
      */
     readonly networkAccessControl?: 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.
+     *
+     * @default - no notification destinations
      */
     readonly notificationDestinations?: 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.
+     *
+     * @default - no organizational units
      */
     readonly organizationalUnits?: string[];
     /**
      * The name of the IAM role that is used to access resources through Organizations.
+     *
+     * @default - no organization role name
      */
     readonly organizationRoleName?: string;
     /**
@@ -355,36 +415,98 @@ export interface IWorkspace extends IResource {
      * 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.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    readonly permissionType: PermissionTypes;
+    readonly permissionType?: PermissionTypes;
     /**
      * 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.
+     *
+     * @default - false
      */
     readonly pluginAdminEnabled?: boolean;
     /**
      * The IAM role that grants permissions to the AWS resources that the workspace will view data
      * from.
+     *
+     * @default - no role is attached
      */
     readonly role?: IRole;
     /**
      * 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.
+     *
+     * @default - no SAML configuration
      */
     readonly samlConfiguration?: SamlConfiguration;
     /**
      * The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for
      * this workspace.
+     *
+     * @default - no stack set name
      */
     readonly stackSetName?: string;
     /**
      * The configuration settings for an Amazon VPC that contains data sources for your Grafana
      * workspace to connect to.
+     *
+     * @default - no VPC connection
      */
     readonly vpcConfiguration?: VpcConfiguration;
+    /**
+     * The date that the workspace was created.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly creationTimestamp?: string;
+    /**
+     * The URL that users can use to access the Grafana console in the workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly endpoint?: string;
+    /**
+     * Specifies the version of Grafana supported by this workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly grafanaVersion?: string;
+    /**
+     * The most recent date that the workspace was modified.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly modificationTimestamp?: string;
+    /**
+     * Specifies whether the workspace's SAML configuration is complete.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly samlConfigurationStatus?: string;
+    /**
+     * The ID of the IAM Identity Center-managed application that is created by Amazon Managed
+     * Grafana.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly ssoClientId?: string;
+    /**
+     * The current status of the workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    readonly status?: string;
     /**
      * The unique ID of this workspace.
      * @attribute
@@ -399,77 +521,159 @@ export interface IWorkspace extends IResource {
 export declare abstract class WorkspaceBase extends Resource implements IWorkspace {
     /**
      * The account access type for the workspace.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    abstract readonly accountAccessType: AccountAccessType;
+    abstract readonly accountAccessType?: AccountAccessType;
     /**
      * The authentication providers for the workspace.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    abstract readonly authenticationProviders: AuthenticationProviders[];
+    abstract readonly authenticationProviders?: AuthenticationProviders[];
     /**
      * The client token for the workspace.
+     *
+     * @default - not available on imported workspaces
      */
     abstract readonly clientToken?: string;
     /**
      * The data sources of this workspace
+     *
+     * @default - no data sources
      */
     abstract readonly dataSources?: string[];
     /**
      * The description of this workspace
+     *
+     * @default - no description
      */
     abstract readonly description?: string;
     /**
      * The name of this workspace
+     *
+     * @default - a name is generated by CloudFormation
      */
     abstract readonly name?: string;
     /**
      * The configuration settings for network access to your workspace.
+     *
+     * @default - no network access control, the workspace is open to all traffic
      */
     abstract readonly networkAccessControl?: NetworkAccessControl;
     /**
      * The notification destinations for the workspace.
+     *
+     * @default - no notification destinations
      */
     abstract readonly notificationDestinations?: 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.
+     *
+     * @default - no organizational units
      */
     abstract readonly organizationalUnits?: string[];
     /**
      * The name of the IAM role that is used to access resources through Organizations.
+     *
+     * @default - no organization role name
      */
     abstract readonly organizationRoleName?: string;
     /**
      * The permission type for the workspace.
+     *
+     * @default - not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
      */
-    abstract readonly permissionType: PermissionTypes;
+    abstract readonly permissionType?: PermissionTypes;
     /**
      * 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.
+     *
+     * @default - false
      */
     abstract readonly pluginAdminEnabled?: boolean;
     /**
      * The IAM role that grants permissions to the AWS resources that the workspace will view data
      * from.
+     *
+     * @default - no role is attached
      */
     abstract readonly role?: IRole;
     /**
      * 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.
+     *
+     * @default - no SAML configuration
      */
     abstract readonly samlConfiguration?: SamlConfiguration;
     /**
      * The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for
      * this workspace.
+     *
+     * @default - no stack set name
      */
     abstract readonly stackSetName?: string;
     /**
      * The configuration settings for an Amazon VPC that contains data sources for your Grafana
      * workspace to connect to.
+     *
+     * @default - no VPC connection
      */
     abstract readonly vpcConfiguration?: VpcConfiguration;
+    /**
+     * The date that the workspace was created.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly creationTimestamp?: string;
+    /**
+     * The URL that users can use to access the Grafana console in the workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly endpoint?: string;
+    /**
+     * Specifies the version of Grafana supported by this workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly grafanaVersion?: string;
+    /**
+     * The most recent date that the workspace was modified.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly modificationTimestamp?: string;
+    /**
+     * Specifies whether the workspace's SAML configuration is complete.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly samlConfigurationStatus?: string;
+    /**
+     * The ID of the IAM Identity Center-managed application that is created by Amazon Managed
+     * Grafana.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly ssoClientId?: string;
+    /**
+     * The current status of the workspace.
+     *
+     * @default - not available on imported workspaces
+     * @attribute
+     */
+    abstract readonly status?: string;
     /**
      * The unique ID of this workspace.
      */