Package software.amazon.awscdk.services.grafana

Interface CfnWorkspace.SamlConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWorkspace.SamlConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnWorkspace
@Stability(Stable) public static interface CfnWorkspace.SamlConfigurationProperty extends software.amazon.jsii.JsiiSerializable
A structure containing information about how this workspace works with SAML.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.grafana.*;
 SamlConfigurationProperty samlConfigurationProperty = SamlConfigurationProperty.builder()
         .idpMetadata(IdpMetadataProperty.builder()
                 .url("url")
                 .xml("xml")
                 .build())
         // the properties below are optional
         .allowedOrganizations(List.of("allowedOrganizations"))
         .assertionAttributes(AssertionAttributesProperty.builder()
                 .email("email")
                 .groups("groups")
                 .login("login")
                 .name("name")
                 .org("org")
                 .role("role")
                 .build())
         .loginValidityDuration(123)
         .roleValues(RoleValuesProperty.builder()
                 .admin(List.of("admin"))
                 .editor(List.of("editor"))
                 .build())
         .build();

  • Method Details

    • getIdpMetadata

      @Stability(Stable) @NotNull Object getIdpMetadata()
      A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

    • getAllowedOrganizations

      @Stability(Stable) @Nullable default List<String> getAllowedOrganizations()
      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.

    • getAssertionAttributes

      @Stability(Stable) @Nullable default Object getAssertionAttributes()
      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.

    • getLoginValidityDuration

      @Stability(Stable) @Nullable default Number getLoginValidityDuration()
      How long a sign-on session by a SAML user is valid, before the user has to sign on again.

    • getRoleValues

      @Stability(Stable) @Nullable default Object getRoleValues()
      A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

    • builder

      @Stability(Stable) static CfnWorkspace.SamlConfigurationProperty.Builder builder()
      Returns:
      a CfnWorkspace.SamlConfigurationProperty.Builder of CfnWorkspace.SamlConfigurationProperty