Package software.amazon.awscdk.services.grafana

Interface CfnWorkspace.AssertionAttributesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspace.AssertionAttributesProperty.Jsii$Proxy

Enclosing class:

CfnWorkspace

@Stability(Stable)
public static interface CfnWorkspace.AssertionAttributesProperty
extends software.amazon.jsii.JsiiSerializable

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.

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.*;
 AssertionAttributesProperty assertionAttributesProperty = AssertionAttributesProperty.builder()
         .email("email")
         .groups("groups")
         .login("login")
         .name("name")
         .org("org")
         .role("role")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspace.AssertionAttributesProperty.Builder	A builder for CfnWorkspace.AssertionAttributesProperty
static final class	CfnWorkspace.AssertionAttributesProperty.Jsii$Proxy	An implementation for CfnWorkspace.AssertionAttributesProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkspace.AssertionAttributesProperty.Builder	builder()
default String	getEmail()	The name of the attribute within the SAML assertion to use as the email names for SAML users.
default String	getGroups()	The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
default String	getLogin()	The name of the attribute within the SAML assertion to use as the login names for SAML users.
default String	getName()	The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
default String	getOrg()	The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
default String	getRole()	The name of the attribute within the SAML assertion to use as the user roles.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmail

@Stability(Stable)
@Nullable
default String getEmail()

The name of the attribute within the SAML assertion to use as the email names for SAML users.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-email

getGroups

@Stability(Stable)
@Nullable
default String getGroups()

The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-groups

getLogin

@Stability(Stable)
@Nullable
default String getLogin()

The name of the attribute within the SAML assertion to use as the login names for SAML users.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-login

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-name

getOrg

@Stability(Stable)
@Nullable
default String getOrg()

The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-org

getRole

@Stability(Stable)
@Nullable
default String getRole()

The name of the attribute within the SAML assertion to use as the user roles.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html#cfn-grafana-workspace-assertionattributes-role

builder

@Stability(Stable)
static CfnWorkspace.AssertionAttributesProperty.Builder builder()

Returns:

a CfnWorkspace.AssertionAttributesProperty.Builder of CfnWorkspace.AssertionAttributesProperty