Package software.amazon.awssdk.services.cognitoidentity.model

Interface RoleMapping.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RoleMapping.Builder,RoleMapping>, SdkBuilder<RoleMapping.Builder,RoleMapping>, SdkPojo
Enclosing class:
RoleMapping
public static interface RoleMapping.Builder extends SdkPojo, CopyableBuilder<RoleMapping.Builder,RoleMapping>

  • Method Details

    • type

      RoleMapping.Builder type(String type)

      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

      Parameters:
      type - The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      RoleMapping.Builder type(RoleMappingType type)

      The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

      Parameters:
      type - The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ambiguousRoleResolution

      RoleMapping.Builder ambiguousRoleResolution(String ambiguousRoleResolution)

      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      Parameters:
      ambiguousRoleResolution - If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ambiguousRoleResolution

      RoleMapping.Builder ambiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution)

      If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      Parameters:
      ambiguousRoleResolution - If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

      Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rulesConfiguration

      RoleMapping.Builder rulesConfiguration(RulesConfigurationType rulesConfiguration)

      The rules to be used for mapping users to roles.

      If you specify Rules as the role mapping type, RulesConfiguration is required.

      Parameters:
      rulesConfiguration - The rules to be used for mapping users to roles.

      If you specify Rules as the role mapping type, RulesConfiguration is required.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rulesConfiguration

      default RoleMapping.Builder rulesConfiguration(Consumer<RulesConfigurationType.Builder> rulesConfiguration)

      The rules to be used for mapping users to roles.

      If you specify Rules as the role mapping type, RulesConfiguration is required.

      This is a convenience method that creates an instance of the RulesConfigurationType.Builder avoiding the need to create one manually via RulesConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rulesConfiguration(RulesConfigurationType).

      Parameters:
      rulesConfiguration - a consumer that will call methods on RulesConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: