CfnWorkspacePropsMixin

class aws_cdk.mixins_preview.aws_grafana.mixins.CfnWorkspacePropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-grafana-workspace.html
CloudformationResource:: AWS::Grafana::Workspace
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

cfn_workspace_props_mixin = grafana_mixins.CfnWorkspacePropsMixin(grafana_mixins.CfnWorkspaceMixinProps(
    account_access_type="accountAccessType",
    authentication_providers=["authenticationProviders"],
    client_token="clientToken",
    data_sources=["dataSources"],
    description="description",
    grafana_version="grafanaVersion",
    name="name",
    network_access_control=grafana_mixins.CfnWorkspacePropsMixin.NetworkAccessControlProperty(
        prefix_list_ids=["prefixListIds"],
        vpce_ids=["vpceIds"]
    ),
    notification_destinations=["notificationDestinations"],
    organizational_units=["organizationalUnits"],
    organization_role_name="organizationRoleName",
    permission_type="permissionType",
    plugin_admin_enabled=False,
    role_arn="roleArn",
    saml_configuration=grafana_mixins.CfnWorkspacePropsMixin.SamlConfigurationProperty(
        allowed_organizations=["allowedOrganizations"],
        assertion_attributes=grafana_mixins.CfnWorkspacePropsMixin.AssertionAttributesProperty(
            email="email",
            groups="groups",
            login="login",
            name="name",
            org="org",
            role="role"
        ),
        idp_metadata=grafana_mixins.CfnWorkspacePropsMixin.IdpMetadataProperty(
            url="url",
            xml="xml"
        ),
        login_validity_duration=123,
        role_values=grafana_mixins.CfnWorkspacePropsMixin.RoleValuesProperty(
            admin=["admin"],
            editor=["editor"]
        )
    ),
    stack_set_name="stackSetName",
    vpc_configuration=grafana_mixins.CfnWorkspacePropsMixin.VpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Grafana::Workspace.

Parameters:

props (Union[CfnWorkspaceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accountAccessType', 'authenticationProviders', 'clientToken', 'dataSources', 'description', 'grafanaVersion', 'name', 'networkAccessControl', 'notificationDestinations', 'organizationalUnits', 'organizationRoleName', 'permissionType', 'pluginAdminEnabled', 'roleArn', 'samlConfiguration', 'stackSetName', 'vpcConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AssertionAttributesProperty

class CfnWorkspacePropsMixin.AssertionAttributesProperty(*, email=None, groups=None, login=None, name=None, org=None, role=None)

Bases: object

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.

Parameters:

email (Optional[str]) – The name of the attribute within the SAML assertion to use as the email names for SAML users.
groups (Optional[str]) – The name of the attribute within the SAML assertion to use as the user full “friendly” names for user groups.
login (Optional[str]) – The name of the attribute within the SAML assertion to use as the login names for SAML users.
name (Optional[str]) – The name of the attribute within the SAML assertion to use as the user full “friendly” names for SAML users.
org (Optional[str]) – The name of the attribute within the SAML assertion to use as the user full “friendly” names for the users’ organizations.
role (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

assertion_attributes_property = grafana_mixins.CfnWorkspacePropsMixin.AssertionAttributesProperty(
    email="email",
    groups="groups",
    login="login",
    name="name",
    org="org",
    role="role"
)

Attributes

email

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

groups

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

login

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

name

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

org

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

role

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

IdpMetadataProperty

class CfnWorkspacePropsMixin.IdpMetadataProperty(*, url=None, xml=None)

Bases: object

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.

Parameters:

url (Optional[str]) – The URL of the location containing the IdP metadata.
xml (Optional[str]) – The full IdP metadata, in XML format.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

idp_metadata_property = grafana_mixins.CfnWorkspacePropsMixin.IdpMetadataProperty(
    url="url",
    xml="xml"
)

Attributes

url

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

xml

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

NetworkAccessControlProperty

class CfnWorkspacePropsMixin.NetworkAccessControlProperty(*, prefix_list_ids=None, vpce_ids=None)

Bases: object

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. .. epigraph:

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.

Parameters:

prefix_list_ids (Optional[Sequence[str]]) – 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 in the Amazon Virtual Private Cloud User Guide .
vpce_ids (Optional[Sequence[str]]) – 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 in the Amazon Managed Grafana User Guide . .. epigraph:: 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

network_access_control_property = grafana_mixins.CfnWorkspacePropsMixin.NetworkAccessControlProperty(
    prefix_list_ids=["prefixListIds"],
    vpce_ids=["vpceIds"]
)

Attributes

prefix_list_ids

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 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

vpce_ids

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 in the Amazon Managed Grafana User Guide . .. epigraph:

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

RoleValuesProperty

class CfnWorkspacePropsMixin.RoleValuesProperty(*, admin=None, editor=None)

Bases: object

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.

Parameters:

admin (Optional[Sequence[str]]) – A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
editor (Optional[Sequence[str]]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

role_values_property = grafana_mixins.CfnWorkspacePropsMixin.RoleValuesProperty(
    admin=["admin"],
    editor=["editor"]
)

Attributes

admin

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

editor

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

SamlConfigurationProperty

class CfnWorkspacePropsMixin.SamlConfigurationProperty(*, allowed_organizations=None, assertion_attributes=None, idp_metadata=None, login_validity_duration=None, role_values=None)

Bases: object

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

Parameters:

allowed_organizations (Optional[Sequence[str]]) – 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.
assertion_attributes (Union[IResolvable, AssertionAttributesProperty, Dict[str, Any], None]) – 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.
idp_metadata (Union[IResolvable, IdpMetadataProperty, Dict[str, Any], None]) – A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
login_validity_duration (Union[int, float, None]) – How long a sign-on session by a SAML user is valid, before the user has to sign on again.
role_values (Union[IResolvable, RoleValuesProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

saml_configuration_property = grafana_mixins.CfnWorkspacePropsMixin.SamlConfigurationProperty(
    allowed_organizations=["allowedOrganizations"],
    assertion_attributes=grafana_mixins.CfnWorkspacePropsMixin.AssertionAttributesProperty(
        email="email",
        groups="groups",
        login="login",
        name="name",
        org="org",
        role="role"
    ),
    idp_metadata=grafana_mixins.CfnWorkspacePropsMixin.IdpMetadataProperty(
        url="url",
        xml="xml"
    ),
    login_validity_duration=123,
    role_values=grafana_mixins.CfnWorkspacePropsMixin.RoleValuesProperty(
        admin=["admin"],
        editor=["editor"]
    )
)

Attributes

allowed_organizations

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

assertion_attributes

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

idp_metadata

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

login_validity_duration

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

role_values

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

VpcConfigurationProperty

class CfnWorkspacePropsMixin.VpcConfigurationProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

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).

Parameters:

security_group_ids (Optional[Sequence[str]]) – 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.
subnet_ids (Optional[Sequence[str]]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_grafana import mixins as grafana_mixins

vpc_configuration_property = grafana_mixins.CfnWorkspacePropsMixin.VpcConfigurationProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

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

subnet_ids

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